@@ -436,7 +436,7 @@ changes:
436
436
-->
437
437
438
438
* ` path ` {string|Buffer|URL}
439
- * ` mode ` {integer}
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}
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.
@@ -1135,7 +1135,7 @@ added: v0.1.96
1135
1135
1136
1136
Synchronous fsync(2). Returns ` undefined ` .
1137
1137
1138
- ## fs.ftruncate(fd, len, callback)
1138
+ ## fs.ftruncate(fd[ , len] , callback)
1139
1139
<!-- YAML
1140
1140
added: v0.8.6
1141
1141
changes:
@@ -1193,7 +1193,7 @@ fs.ftruncate(fd, 10, (err) => {
1193
1193
1194
1194
The last three bytes are null bytes ('\0'), to compensate the over-truncation.
1195
1195
1196
- ## fs.ftruncateSync(fd, len)
1196
+ ## fs.ftruncateSync(fd[ , len] )
1197
1197
<!-- YAML
1198
1198
added: v0.8.6
1199
1199
-->
@@ -1388,7 +1388,7 @@ changes:
1388
1388
-->
1389
1389
1390
1390
* ` path ` {string|Buffer|URL}
1391
- * ` mode ` {integer}
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}
1408
+ * ` mode ` {integer} default = ` 0o777 `
1409
1409
1410
1410
Synchronous mkdir(2). Returns ` undefined ` .
1411
1411
@@ -1506,7 +1506,7 @@ changes:
1506
1506
1507
1507
* ` path ` {string|Buffer|URL}
1508
1508
* ` flags ` {string|number}
1509
- * ` mode ` {integer}
1509
+ * ` mode ` {integer} default = ` 0o666 `
1510
1510
* ` callback ` {Function}
1511
1511
1512
1512
Asynchronous file open. See open(2). ` flags ` can be:
@@ -1548,7 +1548,7 @@ The file is created if it does not exist.
1548
1548
* ` 'ax+' ` - Like ` 'a+' ` but fails if ` path ` exists.
1549
1549
1550
1550
` mode ` sets the file mode (permission and sticky bits), but only if the file was
1551
- created. It defaults to ` 0666 ` , readable and writable.
1551
+ created. It defaults to ` 0o666 ` , readable and writable.
1552
1552
1553
1553
The callback gets two arguments ` (err, fd) ` .
1554
1554
@@ -1595,7 +1595,7 @@ changes:
1595
1595
1596
1596
* ` path ` {string|Buffer|URL}
1597
1597
* ` flags ` {string|number}
1598
- * ` mode ` {integer}
1598
+ * ` mode ` {integer} default = ` 0o666 `
1599
1599
1600
1600
Synchronous version of [ ` fs.open() ` ] [ ] . Returns an integer representing the file
1601
1601
descriptor.
@@ -2063,7 +2063,7 @@ changes:
2063
2063
2064
2064
* ` target ` {string|Buffer|URL}
2065
2065
* ` path ` {string|Buffer|URL}
2066
- * ` type ` {string}
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,11 +2094,11 @@ changes:
2094
2094
2095
2095
* ` target ` {string|Buffer|URL}
2096
2096
* ` path ` {string|Buffer|URL}
2097
- * ` type ` {string}
2097
+ * ` type ` {string} default = ` 'file' `
2098
2098
2099
2099
Synchronous symlink(2). Returns ` undefined ` .
2100
2100
2101
- ## fs.truncate(path, len, callback)
2101
+ ## fs.truncate(path[ , len] , callback)
2102
2102
<!-- YAML
2103
2103
added: v0.8.6
2104
2104
changes:
@@ -2116,7 +2116,7 @@ Asynchronous truncate(2). No arguments other than a possible exception are
2116
2116
given to the completion callback. A file descriptor can also be passed as the
2117
2117
first argument. In this case, ` fs.ftruncate() ` is called.
2118
2118
2119
- ## fs.truncateSync(path, len)
2119
+ ## fs.truncateSync(path[ , len] )
2120
2120
<!-- YAML
2121
2121
added: v0.8.6
2122
2122
-->
@@ -2167,7 +2167,7 @@ added: v0.1.31
2167
2167
-->
2168
2168
2169
2169
* ` filename ` {string|Buffer}
2170
- * ` listener ` {Function}
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,
@@ -2257,7 +2257,7 @@ changes:
2257
2257
` false `
2258
2258
* ` encoding ` {string} Specifies the character encoding to be used for the
2259
2259
filename passed to the listener. default = ` 'utf8' `
2260
- * ` listener ` {Function}
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}
2361
- * ` interval ` {integer}
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
0 commit comments