diff --git a/doc/api/fs.md b/doc/api/fs.md index ab8c8a92bdfc99..40b8a990631271 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -1222,6 +1222,8 @@ added: v0.1.31 Asynchronous realpath(3). The `callback` gets two arguments `(err, resolvedPath)`. May use `process.cwd` to resolve relative paths. +Only paths that can be converted to UTF8 strings are supported. + The optional `options` argument can be a string specifying an encoding, or an object with an `encoding` property specifying the character encoding to use for the path passed to the callback. If the `encoding` is set to `'buffer'`, @@ -1238,10 +1240,12 @@ added: v0.1.31 Synchronous realpath(3). Returns the resolved path. +Only paths that can be converted to UTF8 strings are supported. + The optional `options` argument can be a string specifying an encoding, or an object with an `encoding` property specifying the character encoding to use for -the path passed to the callback. If the `encoding` is set to `'buffer'`, -the path returned will be passed as a `Buffer` object. +the returned value. If the `encoding` is set to `'buffer'`, the path returned +will be passed as a `Buffer` object. ## fs.rename(oldPath, newPath, callback)