fs.readlink(path[, options], callback)

版本历史

版本	变更
v10.0.0	参数 `callback` 不再是可选的。不传入它会在运行时抛出 `TypeError`。
v7.6.0	参数 `path` 可以是使用 `file:` 协议的 WHATWG `URL` 对象。
v7.0.0	参数 `callback` 不再是可选的。不传入它将触发 ID 为 DEP0013 的弃用警告。
v0.1.31	新增于: v0.1.31

path <string> | <Buffer> | <URL>
options <string> | <Object>
- encoding <string> 默认值: 'utf8'
callback <Function>
- err <Error>
- linkString <string> | <Buffer>

读取 path 引用的符号链接的内容。回调有两个参数 (err, linkString)。

有关更多详细信息，请参阅 POSIX readlink(2) 文档。

可选的 options 参数可以是指定编码的字符串，也可以是具有 encoding 属性（指定用于传给回调的链接路径的字符编码）的对象。如果将 encoding 设置为 'buffer'，则返回的链接路径将作为 <Buffer> 对象传入。

History

Version	Changes
v10.0.0	The `callback` parameter is no longer optional. Not passing it will throw a `TypeError` at runtime.
v7.6.0	The `path` parameter can be a WHATWG `URL` object using `file:` protocol.
v7.0.0	The `callback` parameter is no longer optional. Not passing it will emit a deprecation warning with id DEP0013.
v0.1.31	Added in: v0.1.31

path <string> | <Buffer> | <URL>
options <string> | <Object>
- encoding <string> Default: 'utf8'
callback <Function>
- err <Error>
- linkString <string> | <Buffer>

Reads the contents of the symbolic link referred to by path. The callback gets two arguments (err, linkString).

See the POSIX readlink(2) documentation for more details.

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 link path passed to the callback. If the encoding is set to 'buffer', the link path returned will be passed as a <Buffer> object.