The
fs.symlinkSync() method is used to synchronously create a symlink to the specified path. This method creates a link making the
path point to the
target. The relative targets are relative to the link's parent directory.
Syntax:
fs.symlinkSync( target, path, type )
Parameters: This method accept three parameters as mentioned above and described below:
- target: It is a string, buffer or URL which represents the path to which the symlink has to be created.
- path: It is a string, buffer or URL which represents the path where the symlink will be created.
- type: It is a string which represents the type of symlink to be created. It can be specified with 'file', 'dir' or 'junction'. If the target does not exist, 'file' will be used.
Below examples illustrate the
fs.symlinkSync() method in Node.js:
Example 1: This example creates a symlink to a file.
Output:
Contents of the text file:
Hello Geeks
Symlink created
Contents of the symlink created:
Hello Geeks
Example 2: This example creates a symlink to a directory.
Output:
Symlink created
Symlink is a directory: true
Reference: https://nodejs.org/api/fs.html#fs_fs_symlinksync_target_path_type
