doc: suggest alternatives to deprecated APIs #1007
Conversation
|
I suggested a minor wording tweak, but LGTM otherwise. |
mscdex
changed the title
|
|
||
| `fs.existsSync()` is **deprecated**. | ||
| `fs.existsSync()` is **deprecated**. For future proof alternatives please check out [`fs.statSync`](fs.html#fs_fs_statsync_path) or [`fs.access`](fs.html#fs_fs_accesssync_path_mode). |
There was a problem hiding this comment.
It should be fs.accessSync instead of fs.access. The link URL is correct though.
|
Thanks, addressed comments and squashed. |
| @@ -642,6 +642,9 @@ callback, and have some fallback logic if it is null. | |||
|
|
|||
| ## 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). | |||
There was a problem hiding this comment.
Please wrap lines at 80 chars.
There was a problem hiding this comment.
@tellnes I wanted to wrap the line at 80 columns but am unsure how do wrap lines at 80 chars in the source but keep them at 80 characters in the markdown.
Is there a way to wrap the line here while not doing so in the output?
There was a problem hiding this comment.
Isn't single newlines parsed as space in markdown?
Edit: Just wrap after or.
There was a problem hiding this comment.
Let me
try
Edit: no, I'll see if I can find a better solution and if I can't by tomorrow I'll wrap after or
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. This PR closes #1002
|
@tellnes addressed comment and squashed. |
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: #1002 PR-URL: #1007 Reviewed-By: Brian White <mscdex@mscdex.net> Reviewed-By: Christian Tellnes <christian@tellnes.no>
|
Landed as c380ac6 |
At the moment users who want to use
fs.existsget a warning that the method is deprecated but do not get offered an alternative in the page. This PR suggestsfs.statandfs.accessas alternatives while keeping the warning about the use case in place.This PR closes #1002