summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorShobhit Chittora <chittorashobhit@gmail.com>2018-05-06 13:05:21 +0530
committerVse Mozhet Byt <vsemozhetbyt@gmail.com>2018-05-09 00:36:13 +0300
commita76dfd24ec5c76d268ab2c6b6bd6a9cf36f602c6 (patch)
tree918c555cb658770970dcddea8a8e3633f61d14af
parentac894503261e4f509eec2e10e56ff72764abd5f5 (diff)
downloadandroid-node-v8-a76dfd24ec5c76d268ab2c6b6bd6a9cf36f602c6.tar.gz
android-node-v8-a76dfd24ec5c76d268ab2c6b6bd6a9cf36f602c6.tar.bz2
android-node-v8-a76dfd24ec5c76d268ab2c6b6bd6a9cf36f602c6.zip
doc: refactor mode constants parts in fs.md
1. removed extra mode constants doc. 2. creates bookmark to the common File Access Contants block. PR-URL: https://github.com/nodejs/node/pull/20558 Fixes: https://github.com/nodejs/node/issues/20049 Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
-rw-r--r--doc/api/fs.md55
1 files changed, 18 insertions, 37 deletions
diff --git a/doc/api/fs.md b/doc/api/fs.md
index 30d6729d48..286ffb3a63 100644
--- a/doc/api/fs.md
+++ b/doc/api/fs.md
@@ -746,17 +746,9 @@ changes:
Tests a user's permissions for the file or directory specified by `path`.
The `mode` argument is an optional integer that specifies the accessibility
-checks to be performed. The following constants define the possible values of
-`mode`. It is possible to create a mask consisting of the bitwise OR of two or
-more values (e.g. `fs.constants.W_OK | fs.constants.R_OK`).
-
-* `fs.constants.F_OK` - `path` is visible to the calling process. This is useful
-for determining if a file exists, but says nothing about `rwx` permissions.
-Default if no `mode` is specified.
-* `fs.constants.R_OK` - `path` can be read by the calling process.
-* `fs.constants.W_OK` - `path` can be written by the calling process.
-* `fs.constants.X_OK` - `path` can be executed by the calling process. This has
-no effect on Windows (will behave like `fs.constants.F_OK`).
+checks to be performed. Check [File Access Constants][] for possible values
+of `mode`. It is possible to create a mask consisting of the bitwise OR of
+two or more values (e.g. `fs.constants.W_OK | fs.constants.R_OK`).
The final argument, `callback`, is a callback function that is invoked with
a possible error argument. If any of the accessibility checks fail, the error
@@ -889,19 +881,12 @@ changes:
* `path` {string|Buffer|URL}
* `mode` {integer} **Default:** `fs.constants.F_OK`
-Synchronously tests a user's permissions for the file or directory specified by
-`path`. The `mode` argument is an optional integer that specifies the
-accessibility checks to be performed. The following constants define the
-possible values of `mode`. It is possible to create a mask consisting of the
-bitwise OR of two or more values (e.g. `fs.constants.W_OK | fs.constants.R_OK`).
-
-* `fs.constants.F_OK` - `path` is visible to the calling process. This is useful
-for determining if a file exists, but says nothing about `rwx` permissions.
-Default if no `mode` is specified.
-* `fs.constants.R_OK` - `path` can be read by the calling process.
-* `fs.constants.W_OK` - `path` can be written by the calling process.
-* `fs.constants.X_OK` - `path` can be executed by the calling process. This has
-no effect on Windows (will behave like `fs.constants.F_OK`).
+Synchronously tests a user's permissions for the file or directory specified
+by `path`. The `mode` argument is an optional integer that specifies the
+accessibility checks to be performed. Check [File Access Constants][] for
+possible values of `mode`. It is possible to create a mask consisting of
+the bitwise OR of two or more values
+(e.g. `fs.constants.W_OK | fs.constants.R_OK`).
If any of the accessibility checks fail, an `Error` will be thrown. Otherwise,
the method will return `undefined`.
@@ -3679,17 +3664,9 @@ added: v10.0.0
Tests a user's permissions for the file or directory specified by `path`.
The `mode` argument is an optional integer that specifies the accessibility
-checks to be performed. The following constants define the possible values of
-`mode`. It is possible to create a mask consisting of the bitwise OR of two or
-more values (e.g. `fs.constants.W_OK | fs.constants.R_OK`).
-
-* `fs.constants.F_OK` - `path` is visible to the calling process. This is useful
-for determining if a file exists, but says nothing about `rwx` permissions.
-Default if no `mode` is specified.
-* `fs.constants.R_OK` - `path` can be read by the calling process.
-* `fs.constants.W_OK` - `path` can be written by the calling process.
-* `fs.constants.X_OK` - `path` can be executed by the calling process. This has
-no effect on Windows (will behave like `fs.constants.F_OK`).
+checks to be performed. Check [File Access Constants][] for possible values
+of `mode`. It is possible to create a mask consisting of the bitwise OR of
+two or more values (e.g. `fs.constants.W_OK | fs.constants.R_OK`).
If the accessibility check is successful, the `Promise` is resolved with no
value. If any of the accessibility checks fail, the `Promise` is rejected
@@ -4329,7 +4306,9 @@ The following constants are meant for use with [`fs.access()`][].
</tr>
<tr>
<td><code>F_OK</code></td>
- <td>Flag indicating that the file is visible to the calling process.</td>
+ <td>Flag indicating that the file is visible to the calling process.
+ This is useful for determining if a file exists, but says nothing
+ about <code>rwx</code> permissions. Default if no mode is specified.</td>
</tr>
<tr>
<td><code>R_OK</code></td>
@@ -4343,7 +4322,8 @@ The following constants are meant for use with [`fs.access()`][].
<tr>
<td><code>X_OK</code></td>
<td>Flag indicating that the file can be executed by the calling
- process.</td>
+ process. This has no effect on Windows
+ (will behave like <code>fs.constants.F_OK</code>).</td>
</tr>
</table>
@@ -4706,3 +4686,4 @@ the file contents.
[Naming Files, Paths, and Namespaces]: https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247(v=vs.85).aspx
[MSDN-Using-Streams]: https://msdn.microsoft.com/en-us/library/windows/desktop/bb540537.aspx
[support of file system `flags`]: #fs_file_system_flags
+[File Access Constants]: #fs_file_access_constants