Jump to headingsymlink(): void
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'
, thetarget
argument will automatically be normalized to absolute path. Junction
points on NTFS volumes can only point to directories.
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
Parameters Jump to heading
Jump to headingtarget: PathLike
Jump to headingpath: PathLike
Jump to headingtype: = 'null'
Jump to headingcallback: NoParamCallback
Return Type Jump to heading
void
Jump to headingsymlink(): void
Asynchronous symlink(2) - Create a new symbolic link to an existing file.
Parameters Jump to heading
Jump to headingtarget: PathLike
A path to an existing file. If a URL is provided, it must use the file:
protocol.
Jump to headingpath: PathLike
A path to the new symlink. If a URL is provided, it must use the file:
protocol.
Jump to headingcallback: NoParamCallback
Return Type Jump to heading
void