fs.symlink(target, path[, type], callback)

• target <string> | <Buffer> | <URL>
• path <string> | <Buffer> | <URL>
• type <string> | <null> 默认值: null
• callback <Function>
  • err <Error>

创建名为 path 指向 target 的链接。 除了可能的异常之外，没有为完成回调提供任何参数。

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

type 参数仅在 Windows 上可用，在其他平台上被忽略。 可以设置为 'dir'、'file' 或 'junction'。 如果 type 参数不是字符串，则 Node.js 将自动检测 target 类型并使用 'file' 或 'dir'。 如果 target 不存在，将使用 'file'。 Windows 交接点要求目标路径是绝对路径。 使用 'junction' 时，target 参数将自动规范化为绝对路径。

相对目标是相对于链接的父目录。

import { symlink } from 'node:fs';

symlink('./mew', './mewtwo', callback);

上面的示例创建了符号链接 mewtwo，其指向同一目录中的 mew：

$ tree .
.
├── mew
└── mewtwo -> ./mew

• target <string> | <Buffer> | <URL>
• path <string> | <Buffer> | <URL>
• type <string> | <null> Default: null
• callback <Function>
  • err <Error>

Creates the link called path pointing to target. No arguments other than a possible exception are given to the completion callback.

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

The type argument is only available on Windows and ignored on other platforms. It can be set to 'dir', 'file', or 'junction'. If the type argument is not a string, Node.js will autodetect target type and use 'file' or 'dir'. If the target does not exist, 'file' will be used. Windows junction points require the destination path to be absolute. When using 'junction', the target argument will automatically be normalized to absolute path.

Relative targets are relative to the link's parent directory.

import { symlink } from 'node:fs';

symlink('./mew', './mewtwo', callback);

The above example creates a symbolic link mewtwo which points to mew in the same directory:

$ tree .
.
├── mew
└── mewtwo -> ./mew