doc: suggest alternatives to deprecated APs

At the moment users who want to use `fs.exists` get a warning that the
method is deprecated but do not get offered an alternative in the page.
This PR suggests `fs.stat` and `fs.access` as alternatives while
keeping the warning about the use case in place.

Fixes: https://github.com/iojs/io.js/issues/1002
PR-URL: https://github.com/iojs/io.js/pull/1007
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: Christian Tellnes <christian@tellnes.no>
This commit is contained in:
Benjamin Gruenbaum 2015-02-28 22:30:03 +02:00 committed by Christian Tellnes
parent 2b47fd2eb6
commit c380ac6e98

View File

@ -642,6 +642,10 @@ callback, and have some fallback logic if it is null.
## fs.exists(path, callback) ## fs.exists(path, callback)
`fs.exists()` is **deprecated**. For supported alternatives please check out
[`fs.stat`](fs.html#fs_fs_stat_path_callback) or
[`fs.access`](fs.html#fs_fs_access_path_mode_callback).
Test whether or not the given path exists by checking with the file system. Test whether or not the given path exists by checking with the file system.
Then call the `callback` argument with either true or false. Example: Then call the `callback` argument with either true or false. Example:
@ -657,13 +661,15 @@ that leaves you vulnerable to race conditions: another process may remove the
file between the calls to `fs.exists()` and `fs.open()`. Just open the file file between the calls to `fs.exists()` and `fs.open()`. Just open the file
and handle the error when it's not there. and handle the error when it's not there.
`fs.exists()` is **deprecated**.
## fs.existsSync(path) ## fs.existsSync(path)
Synchronous version of `fs.exists`. Synchronous version of [`fs.exists`](fs.html#fs_fs_exists_path_callback).
`fs.existsSync()` is **deprecated**. `fs.existsSync()` is **deprecated**. For supported alternatives please check
out [`fs.statSync`](fs.html#fs_fs_statsync_path) or
[`fs.accessSync`](fs.html#fs_fs_accesssync_path_mode).
## fs.access(path[, mode], callback) ## fs.access(path[, mode], callback)