@@ -436,7 +436,7 @@ changes:
436
436
-->
437
437
438
438
* ` path ` {string|Buffer|URL}
439
- * ` mode ` {integer} default = ` fs.constants.F_OK `
439
+ * ` mode ` {integer} ** Default: ** ` fs.constants.F_OK `
440
440
* ` callback ` {Function}
441
441
442
442
Tests a user's permissions for the file or directory specified by ` path ` .
@@ -562,7 +562,7 @@ changes:
562
562
-->
563
563
564
564
* ` path ` {string|Buffer|URL}
565
- * ` mode ` {integer} default = ` fs.constants.F_OK `
565
+ * ` mode ` {integer} ** Default: ** ` fs.constants.F_OK `
566
566
567
567
Synchronous version of [ ` fs.access() ` ] [ ] . This throws if any accessibility
568
568
checks fail, and does nothing otherwise.
@@ -586,9 +586,9 @@ changes:
586
586
* ` file ` {string|Buffer|number} filename or file descriptor
587
587
* ` data ` {string|Buffer}
588
588
* ` 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' `
592
592
* ` callback ` {Function}
593
593
594
594
Asynchronously append data to a file, creating the file if it does not yet exist.
@@ -629,9 +629,9 @@ changes:
629
629
* ` file ` {string|Buffer|number} filename or file descriptor
630
630
* ` data ` {string|Buffer}
631
631
* ` 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' `
635
635
636
636
The synchronous version of [ ` fs.appendFile() ` ] [ ] . Returns ` undefined ` .
637
637
@@ -1146,7 +1146,7 @@ changes:
1146
1146
-->
1147
1147
1148
1148
* ` fd ` {integer}
1149
- * ` len ` {integer} default = ` 0 `
1149
+ * ` len ` {integer} ** Default: ** ` 0 `
1150
1150
* ` callback ` {Function}
1151
1151
1152
1152
Asynchronous ftruncate(2). No arguments other than a possible exception are
@@ -1199,7 +1199,7 @@ added: v0.8.6
1199
1199
-->
1200
1200
1201
1201
* ` fd ` {integer}
1202
- * ` len ` {integer} default = ` 0 `
1202
+ * ` len ` {integer} ** Default: ** ` 0 `
1203
1203
1204
1204
Synchronous ftruncate(2). Returns ` undefined ` .
1205
1205
@@ -1388,7 +1388,7 @@ changes:
1388
1388
-->
1389
1389
1390
1390
* ` path ` {string|Buffer|URL}
1391
- * ` mode ` {integer} default = ` 0o777 `
1391
+ * ` mode ` {integer} ** Default: ** ` 0o777 `
1392
1392
* ` callback ` {Function}
1393
1393
1394
1394
Asynchronous mkdir(2). No arguments other than a possible exception are given
@@ -1405,7 +1405,7 @@ changes:
1405
1405
-->
1406
1406
1407
1407
* ` path ` {string|Buffer|URL}
1408
- * ` mode ` {integer} default = ` 0o777 `
1408
+ * ` mode ` {integer} ** Default: ** ` 0o777 `
1409
1409
1410
1410
Synchronous mkdir(2). Returns ` undefined ` .
1411
1411
@@ -1424,7 +1424,7 @@ changes:
1424
1424
1425
1425
* ` prefix ` {string}
1426
1426
* ` options ` {string|Object}
1427
- * ` encoding ` {string} default = ` 'utf8' `
1427
+ * ` encoding ` {string} ** Default: ** ` 'utf8' `
1428
1428
* ` callback ` {Function}
1429
1429
1430
1430
Creates a unique temporary directory.
@@ -1486,7 +1486,7 @@ added: v5.10.0
1486
1486
1487
1487
* ` prefix ` {string}
1488
1488
* ` options ` {string|Object}
1489
- * ` encoding ` {string} default = ` 'utf8' `
1489
+ * ` encoding ` {string} ** Default: ** ` 'utf8' `
1490
1490
1491
1491
The synchronous version of [ ` fs.mkdtemp() ` ] [ ] . Returns the created
1492
1492
folder path.
@@ -1506,7 +1506,7 @@ changes:
1506
1506
1507
1507
* ` path ` {string|Buffer|URL}
1508
1508
* ` flags ` {string|number}
1509
- * ` mode ` {integer} default = ` 0o666 `
1509
+ * ` mode ` {integer} ** Default: ** ` 0o666 `
1510
1510
* ` callback ` {Function}
1511
1511
1512
1512
Asynchronous file open. See open(2). ` flags ` can be:
@@ -1595,7 +1595,7 @@ changes:
1595
1595
1596
1596
* ` path ` {string|Buffer|URL}
1597
1597
* ` flags ` {string|number}
1598
- * ` mode ` {integer} default = ` 0o666 `
1598
+ * ` mode ` {integer} ** Default: ** ` 0o666 `
1599
1599
1600
1600
Synchronous version of [ ` fs.open() ` ] [ ] . Returns an integer representing the file
1601
1601
descriptor.
@@ -1654,7 +1654,7 @@ changes:
1654
1654
1655
1655
* ` path ` {string|Buffer|URL}
1656
1656
* ` options ` {string|Object}
1657
- * ` encoding ` {string} default = ` 'utf8' `
1657
+ * ` encoding ` {string} ** Default: ** ` 'utf8' `
1658
1658
* ` callback ` {Function}
1659
1659
1660
1660
Asynchronous readdir(3). Reads the contents of a directory.
@@ -1678,7 +1678,7 @@ changes:
1678
1678
1679
1679
* ` path ` {string|Buffer|URL}
1680
1680
* ` options ` {string|Object}
1681
- * ` encoding ` {string} default = ` 'utf8' `
1681
+ * ` encoding ` {string} ** Default: ** ` 'utf8' `
1682
1682
1683
1683
Synchronous readdir(3). Returns an array of filenames excluding ` '.' ` and
1684
1684
` '..' ` .
@@ -1711,8 +1711,8 @@ changes:
1711
1711
1712
1712
* ` path ` {string|Buffer|URL|integer} filename or file descriptor
1713
1713
* ` 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' `
1716
1716
* ` callback ` {Function}
1717
1717
1718
1718
Asynchronously reads the entire contents of a file. Example:
@@ -1771,8 +1771,8 @@ changes:
1771
1771
1772
1772
* ` path ` {string|Buffer|URL|integer} filename or file descriptor
1773
1773
* ` 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' `
1776
1776
1777
1777
Synchronous version of [ ` fs.readFile() ` ] [ ] . Returns the contents of the ` path ` .
1778
1778
@@ -1807,7 +1807,7 @@ changes:
1807
1807
1808
1808
* ` path ` {string|Buffer|URL}
1809
1809
* ` options ` {string|Object}
1810
- * ` encoding ` {string} default = ` 'utf8' `
1810
+ * ` encoding ` {string} ** Default: ** ` 'utf8' `
1811
1811
* ` callback ` {Function}
1812
1812
1813
1813
Asynchronous readlink(2). The callback gets two arguments `(err,
@@ -1830,7 +1830,7 @@ changes:
1830
1830
1831
1831
* ` path ` {string|Buffer|URL}
1832
1832
* ` options ` {string|Object}
1833
- * ` encoding ` {string} default = ` 'utf8' `
1833
+ * ` encoding ` {string} ** Default: ** ` 'utf8' `
1834
1834
1835
1835
Synchronous readlink(2). Returns the symbolic link's string value.
1836
1836
@@ -1882,7 +1882,7 @@ changes:
1882
1882
1883
1883
* ` path ` {string|Buffer|URL}
1884
1884
* ` options ` {string|Object}
1885
- * ` encoding ` {string} default = ` 'utf8' `
1885
+ * ` encoding ` {string} ** Default: ** ` 'utf8' `
1886
1886
* ` callback ` {Function}
1887
1887
1888
1888
Asynchronous realpath(3). The ` callback ` gets two arguments `(err,
@@ -1920,7 +1920,7 @@ changes:
1920
1920
1921
1921
* ` path ` {string|Buffer|URL}
1922
1922
* ` options ` {string|Object}
1923
- * ` encoding ` {string} default = ` 'utf8' `
1923
+ * ` encoding ` {string} ** Default: ** ` 'utf8' `
1924
1924
1925
1925
Synchronous realpath(3). Returns the resolved path.
1926
1926
@@ -2063,7 +2063,7 @@ changes:
2063
2063
2064
2064
* ` target ` {string|Buffer|URL}
2065
2065
* ` path ` {string|Buffer|URL}
2066
- * ` type ` {string} default = ` 'file' `
2066
+ * ` type ` {string} ** Default: ** ` 'file' `
2067
2067
* ` callback ` {Function}
2068
2068
2069
2069
Asynchronous symlink(2). No arguments other than a possible exception are given
@@ -2094,7 +2094,7 @@ changes:
2094
2094
2095
2095
* ` target ` {string|Buffer|URL}
2096
2096
* ` path ` {string|Buffer|URL}
2097
- * ` type ` {string} default = ` 'file' `
2097
+ * ` type ` {string} ** Default: ** ` 'file' `
2098
2098
2099
2099
Synchronous symlink(2). Returns ` undefined ` .
2100
2100
@@ -2109,7 +2109,7 @@ changes:
2109
2109
-->
2110
2110
2111
2111
* ` path ` {string|Buffer}
2112
- * ` len ` {integer} default = ` 0 `
2112
+ * ` len ` {integer} ** Default: ** ` 0 `
2113
2113
* ` callback ` {Function}
2114
2114
2115
2115
Asynchronous truncate(2). No arguments other than a possible exception are
@@ -2122,7 +2122,7 @@ added: v0.8.6
2122
2122
-->
2123
2123
2124
2124
* ` path ` {string|Buffer}
2125
- * ` len ` {integer} default = ` 0 `
2125
+ * ` len ` {integer} ** Default: ** ` 0 `
2126
2126
2127
2127
Synchronous truncate(2). Returns ` undefined ` . A file descriptor can also be
2128
2128
passed as the first argument. In this case, ` fs.ftruncateSync() ` is called.
@@ -2167,7 +2167,7 @@ added: v0.1.31
2167
2167
-->
2168
2168
2169
2169
* ` filename ` {string|Buffer}
2170
- * ` listener ` {Function|undefined} default = ` undefined `
2170
+ * ` listener ` {Function|undefined} ** Default: ** ` undefined `
2171
2171
2172
2172
Stop watching for changes on ` filename ` . If ` listener ` is specified, only that
2173
2173
particular listener is removed. Otherwise, * all* listeners are removed,
@@ -2250,14 +2250,14 @@ changes:
2250
2250
* ` filename ` {string|Buffer|URL}
2251
2251
* ` options ` {string|Object}
2252
2252
* ` 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 `
2254
2254
* ` recursive ` {boolean} Indicates whether all subdirectories should be
2255
2255
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: **
2257
2257
` false `
2258
2258
* ` 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 `
2261
2261
2262
2262
Watch for changes on ` filename ` , where ` filename ` is either a file or a
2263
2263
directory. The returned object is a [ ` fs.FSWatcher ` ] [ ] .
@@ -2357,8 +2357,8 @@ changes:
2357
2357
2358
2358
* ` filename ` {string|Buffer|URL}
2359
2359
* ` options ` {Object}
2360
- * ` persistent ` {boolean} default = ` true `
2361
- * ` interval ` {integer} default = ` 5007 `
2360
+ * ` persistent ` {boolean} ** Default: ** ` true `
2361
+ * ` interval ` {integer} ** Default: ** ` 5007 `
2362
2362
* ` listener ` {Function}
2363
2363
2364
2364
Watch for changes on ` filename ` . The callback ` listener ` will be called each
@@ -2506,9 +2506,9 @@ changes:
2506
2506
* ` file ` {string|Buffer|integer} filename or file descriptor
2507
2507
* ` data ` {string|Buffer|Uint8Array}
2508
2508
* ` 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' `
2512
2512
* ` callback ` {Function}
2513
2513
2514
2514
Asynchronously writes data to a file, replacing the file if it already exists.
@@ -2556,9 +2556,9 @@ changes:
2556
2556
* ` file ` {string|Buffer|integer} filename or file descriptor
2557
2557
* ` data ` {string|Buffer|Uint8Array}
2558
2558
* ` 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' `
2562
2562
2563
2563
The synchronous version of [ ` fs.writeFile() ` ] [ ] . Returns ` undefined ` .
2564
2564
0 commit comments