Skip to content

Commit 0cfdbde

Browse files
doc: update fs.md to new default values style
Refs: nodejs#13769 New style is introduced in PR nodejs#13769.
1 parent 4a12748 commit 0cfdbde

File tree

1 file changed

+43
-43
lines changed

1 file changed

+43
-43
lines changed

doc/api/fs.md

+43-43
Original file line numberDiff line numberDiff line change
@@ -436,7 +436,7 @@ changes:
436436
-->
437437

438438
* `path` {string|Buffer|URL}
439-
* `mode` {integer} default = `fs.constants.F_OK`
439+
* `mode` {integer} **Default:** `fs.constants.F_OK`
440440
* `callback` {Function}
441441

442442
Tests a user's permissions for the file or directory specified by `path`.
@@ -562,7 +562,7 @@ changes:
562562
-->
563563

564564
* `path` {string|Buffer|URL}
565-
* `mode` {integer} default = `fs.constants.F_OK`
565+
* `mode` {integer} **Default:** `fs.constants.F_OK`
566566

567567
Synchronous version of [`fs.access()`][]. This throws if any accessibility
568568
checks fail, and does nothing otherwise.
@@ -586,9 +586,9 @@ changes:
586586
* `file` {string|Buffer|number} filename or file descriptor
587587
* `data` {string|Buffer}
588588
* `options` {Object|string}
589-
* `encoding` {string|null} default = `'utf8'`
590-
* `mode` {integer} default = `0o666`
591-
* `flag` {string} default = `'a'`
589+
* `encoding` {string|null} **Default:** `'utf8'`
590+
* `mode` {integer} **Default:** `0o666`
591+
* `flag` {string} **Default:** `'a'`
592592
* `callback` {Function}
593593

594594
Asynchronously append data to a file, creating the file if it does not yet exist.
@@ -629,9 +629,9 @@ changes:
629629
* `file` {string|Buffer|number} filename or file descriptor
630630
* `data` {string|Buffer}
631631
* `options` {Object|string}
632-
* `encoding` {string|null} default = `'utf8'`
633-
* `mode` {integer} default = `0o666`
634-
* `flag` {string} default = `'a'`
632+
* `encoding` {string|null} **Default:** `'utf8'`
633+
* `mode` {integer} **Default:** `0o666`
634+
* `flag` {string} **Default:** `'a'`
635635

636636
The synchronous version of [`fs.appendFile()`][]. Returns `undefined`.
637637

@@ -1146,7 +1146,7 @@ changes:
11461146
-->
11471147

11481148
* `fd` {integer}
1149-
* `len` {integer} default = `0`
1149+
* `len` {integer} **Default:** `0`
11501150
* `callback` {Function}
11511151

11521152
Asynchronous ftruncate(2). No arguments other than a possible exception are
@@ -1199,7 +1199,7 @@ added: v0.8.6
11991199
-->
12001200

12011201
* `fd` {integer}
1202-
* `len` {integer} default = `0`
1202+
* `len` {integer} **Default:** `0`
12031203

12041204
Synchronous ftruncate(2). Returns `undefined`.
12051205

@@ -1388,7 +1388,7 @@ changes:
13881388
-->
13891389

13901390
* `path` {string|Buffer|URL}
1391-
* `mode` {integer} default = `0o777`
1391+
* `mode` {integer} **Default:** `0o777`
13921392
* `callback` {Function}
13931393

13941394
Asynchronous mkdir(2). No arguments other than a possible exception are given
@@ -1405,7 +1405,7 @@ changes:
14051405
-->
14061406

14071407
* `path` {string|Buffer|URL}
1408-
* `mode` {integer} default = `0o777`
1408+
* `mode` {integer} **Default:** `0o777`
14091409

14101410
Synchronous mkdir(2). Returns `undefined`.
14111411

@@ -1424,7 +1424,7 @@ changes:
14241424

14251425
* `prefix` {string}
14261426
* `options` {string|Object}
1427-
* `encoding` {string} default = `'utf8'`
1427+
* `encoding` {string} **Default:** `'utf8'`
14281428
* `callback` {Function}
14291429

14301430
Creates a unique temporary directory.
@@ -1486,7 +1486,7 @@ added: v5.10.0
14861486

14871487
* `prefix` {string}
14881488
* `options` {string|Object}
1489-
* `encoding` {string} default = `'utf8'`
1489+
* `encoding` {string} **Default:** `'utf8'`
14901490

14911491
The synchronous version of [`fs.mkdtemp()`][]. Returns the created
14921492
folder path.
@@ -1506,7 +1506,7 @@ changes:
15061506

15071507
* `path` {string|Buffer|URL}
15081508
* `flags` {string|number}
1509-
* `mode` {integer} default = `0o666`
1509+
* `mode` {integer} **Default:** `0o666`
15101510
* `callback` {Function}
15111511

15121512
Asynchronous file open. See open(2). `flags` can be:
@@ -1595,7 +1595,7 @@ changes:
15951595

15961596
* `path` {string|Buffer|URL}
15971597
* `flags` {string|number}
1598-
* `mode` {integer} default = `0o666`
1598+
* `mode` {integer} **Default:** `0o666`
15991599

16001600
Synchronous version of [`fs.open()`][]. Returns an integer representing the file
16011601
descriptor.
@@ -1654,7 +1654,7 @@ changes:
16541654

16551655
* `path` {string|Buffer|URL}
16561656
* `options` {string|Object}
1657-
* `encoding` {string} default = `'utf8'`
1657+
* `encoding` {string} **Default:** `'utf8'`
16581658
* `callback` {Function}
16591659

16601660
Asynchronous readdir(3). Reads the contents of a directory.
@@ -1678,7 +1678,7 @@ changes:
16781678

16791679
* `path` {string|Buffer|URL}
16801680
* `options` {string|Object}
1681-
* `encoding` {string} default = `'utf8'`
1681+
* `encoding` {string} **Default:** `'utf8'`
16821682

16831683
Synchronous readdir(3). Returns an array of filenames excluding `'.'` and
16841684
`'..'`.
@@ -1711,8 +1711,8 @@ changes:
17111711

17121712
* `path` {string|Buffer|URL|integer} filename or file descriptor
17131713
* `options` {Object|string}
1714-
* `encoding` {string|null} default = `null`
1715-
* `flag` {string} default = `'r'`
1714+
* `encoding` {string|null} **Default:** `null`
1715+
* `flag` {string} **Default:** `'r'`
17161716
* `callback` {Function}
17171717

17181718
Asynchronously reads the entire contents of a file. Example:
@@ -1771,8 +1771,8 @@ changes:
17711771

17721772
* `path` {string|Buffer|URL|integer} filename or file descriptor
17731773
* `options` {Object|string}
1774-
* `encoding` {string|null} default = `null`
1775-
* `flag` {string} default = `'r'`
1774+
* `encoding` {string|null} **Default:** `null`
1775+
* `flag` {string} **Default:** `'r'`
17761776

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

@@ -1807,7 +1807,7 @@ changes:
18071807

18081808
* `path` {string|Buffer|URL}
18091809
* `options` {string|Object}
1810-
* `encoding` {string} default = `'utf8'`
1810+
* `encoding` {string} **Default:** `'utf8'`
18111811
* `callback` {Function}
18121812

18131813
Asynchronous readlink(2). The callback gets two arguments `(err,
@@ -1830,7 +1830,7 @@ changes:
18301830

18311831
* `path` {string|Buffer|URL}
18321832
* `options` {string|Object}
1833-
* `encoding` {string} default = `'utf8'`
1833+
* `encoding` {string} **Default:** `'utf8'`
18341834

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

@@ -1882,7 +1882,7 @@ changes:
18821882

18831883
* `path` {string|Buffer|URL}
18841884
* `options` {string|Object}
1885-
* `encoding` {string} default = `'utf8'`
1885+
* `encoding` {string} **Default:** `'utf8'`
18861886
* `callback` {Function}
18871887

18881888
Asynchronous realpath(3). The `callback` gets two arguments `(err,
@@ -1920,7 +1920,7 @@ changes:
19201920

19211921
* `path` {string|Buffer|URL}
19221922
* `options` {string|Object}
1923-
* `encoding` {string} default = `'utf8'`
1923+
* `encoding` {string} **Default:** `'utf8'`
19241924

19251925
Synchronous realpath(3). Returns the resolved path.
19261926

@@ -2063,7 +2063,7 @@ changes:
20632063

20642064
* `target` {string|Buffer|URL}
20652065
* `path` {string|Buffer|URL}
2066-
* `type` {string} default = `'file'`
2066+
* `type` {string} **Default:** `'file'`
20672067
* `callback` {Function}
20682068

20692069
Asynchronous symlink(2). No arguments other than a possible exception are given
@@ -2094,7 +2094,7 @@ changes:
20942094

20952095
* `target` {string|Buffer|URL}
20962096
* `path` {string|Buffer|URL}
2097-
* `type` {string} default = `'file'`
2097+
* `type` {string} **Default:** `'file'`
20982098

20992099
Synchronous symlink(2). Returns `undefined`.
21002100

@@ -2109,7 +2109,7 @@ changes:
21092109
-->
21102110

21112111
* `path` {string|Buffer}
2112-
* `len` {integer} default = `0`
2112+
* `len` {integer} **Default:** `0`
21132113
* `callback` {Function}
21142114

21152115
Asynchronous truncate(2). No arguments other than a possible exception are
@@ -2122,7 +2122,7 @@ added: v0.8.6
21222122
-->
21232123

21242124
* `path` {string|Buffer}
2125-
* `len` {integer} default = `0`
2125+
* `len` {integer} **Default:** `0`
21262126

21272127
Synchronous truncate(2). Returns `undefined`. A file descriptor can also be
21282128
passed as the first argument. In this case, `fs.ftruncateSync()` is called.
@@ -2167,7 +2167,7 @@ added: v0.1.31
21672167
-->
21682168

21692169
* `filename` {string|Buffer}
2170-
* `listener` {Function|undefined} default = `undefined`
2170+
* `listener` {Function|undefined} **Default:** `undefined`
21712171

21722172
Stop watching for changes on `filename`. If `listener` is specified, only that
21732173
particular listener is removed. Otherwise, *all* listeners are removed,
@@ -2250,14 +2250,14 @@ changes:
22502250
* `filename` {string|Buffer|URL}
22512251
* `options` {string|Object}
22522252
* `persistent` {boolean} Indicates whether the process should continue to run
2253-
as long as files are being watched. default = `true`
2253+
as long as files are being watched. **Default:** `true`
22542254
* `recursive` {boolean} Indicates whether all subdirectories should be
22552255
watched, or only the current directory. This applies when a directory is
2256-
specified, and only on supported platforms (See [Caveats][]). default =
2256+
specified, and only on supported platforms (See [Caveats][]). **Default:**
22572257
`false`
22582258
* `encoding` {string} Specifies the character encoding to be used for the
2259-
filename passed to the listener. default = `'utf8'`
2260-
* `listener` {Function|undefined} default = `undefined`
2259+
filename passed to the listener. **Default:** `'utf8'`
2260+
* `listener` {Function|undefined} **Default:** `undefined`
22612261

22622262
Watch for changes on `filename`, where `filename` is either a file or a
22632263
directory. The returned object is a [`fs.FSWatcher`][].
@@ -2357,8 +2357,8 @@ changes:
23572357

23582358
* `filename` {string|Buffer|URL}
23592359
* `options` {Object}
2360-
* `persistent` {boolean} default = `true`
2361-
* `interval` {integer} default = `5007`
2360+
* `persistent` {boolean} **Default:** `true`
2361+
* `interval` {integer} **Default:** `5007`
23622362
* `listener` {Function}
23632363

23642364
Watch for changes on `filename`. The callback `listener` will be called each
@@ -2506,9 +2506,9 @@ changes:
25062506
* `file` {string|Buffer|integer} filename or file descriptor
25072507
* `data` {string|Buffer|Uint8Array}
25082508
* `options` {Object|string}
2509-
* `encoding` {string|null} default = `'utf8'`
2510-
* `mode` {integer} default = `0o666`
2511-
* `flag` {string} default = `'w'`
2509+
* `encoding` {string|null} **Default:** `'utf8'`
2510+
* `mode` {integer} **Default:** `0o666`
2511+
* `flag` {string} **Default:** `'w'`
25122512
* `callback` {Function}
25132513

25142514
Asynchronously writes data to a file, replacing the file if it already exists.
@@ -2556,9 +2556,9 @@ changes:
25562556
* `file` {string|Buffer|integer} filename or file descriptor
25572557
* `data` {string|Buffer|Uint8Array}
25582558
* `options` {Object|string}
2559-
* `encoding` {string|null} default = `'utf8'`
2560-
* `mode` {integer} default = `0o666`
2561-
* `flag` {string} default = `'w'`
2559+
* `encoding` {string|null} **Default:** `'utf8'`
2560+
* `mode` {integer} **Default:** `0o666`
2561+
* `flag` {string} **Default:** `'w'`
25622562

25632563
The synchronous version of [`fs.writeFile()`][]. Returns `undefined`.
25642564

0 commit comments

Comments
 (0)