Node.js fs.symlinkSync() Method

Last Updated : 11 Oct, 2021

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.

javascript

// Node.js program to demonstrate the
// fs.symlinkSync() method

// Import the filesystem module
const fs = require('fs');

console.log("Contents of the text file:");
console.log(
  fs.readFileSync('example_file.txt', 'utf8')
);

fs.symlinkSync(__dirname + "\\example_file.txt",
               "symlinkToFile", 'file');

console.log("\nSymlink created\n");
console.log("Contents of the symlink created:");
console.log(
  fs.readFileSync('symlinkToFile', 'utf8')
);

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.

javascript

// Node.js program to demonstrate the
// fs.symlinkSync() method

// Import the filesystem module
const fs = require('fs');

fs.symlinkSync(__dirname + "\\example_directory",
               "symlinkToDir", 'dir');

console.log("Symlink created");
console.log("Symlink is a directory:", 
  fs.statSync("symlinkToDir").isDirectory()
);

Output:

Symlink created
Symlink is a directory: true

Reference: https://nodejs.org/api/fs.html#fs_fs_symlinksync_target_path_type

S

sayantanm19

Improve

Article Tags :

Similar Reads

Node JS fs.readFile() Method

â€‹In Node.js, the fs.readFile() method is a fundamental tool for reading files asynchronously, allowing your application to remain responsive while accessing file data. This method is part of Node.js's File System (fs) module, which provides an API for interacting with the file system.Syntaxfs.readFi

Node.js fs.exists() Method

The fs exists method in node is used to check if the input file or the directory exists or not. It is an inbuilt application programming interface of fs module which provides an API for interacting with the file system in a manner closely modeled around POSIX functions. Syntax:fs.exists( path, callb

Node fs.existsSync() Method

In Node.js, the fs.existsSync() method checks if a file or folder exists at a given path. It's synchronous, meaning it pauses the program until it finds the result (either true if it exists, or false if it doesn't). Because it stops everything while it works, itâ€™s best used for quick checks in small

Node fs.mkdir() Method

The fs.mkdir() method in Node.js is used to create a directory asynchronously.Syntaxfs.mkdir(path, mode, callback)Parameters: This method accepts three parameters as mentioned above and described below: path: This parameter holds the path of the directory that has to be created.mode: This parameter

Node.js fs.truncate() Method

The fs.truncate() method in node.js is used to change the size of the file i.e either increase or decrease the file size. This method changes the length of the file at the path by len bytes. If len represents a length shorter than the file's current length, the file is truncated to that length. If i

Node.js fs.renameSync() Method

In Node.js, the fs.renameSync() method is part of the built-in File System (fs) module and is used to rename or move files and directories synchronously. This method is useful when you need to quickly change a file's name or move it to a different directory synchronously. It blocks the execution of

Node.js fs.rmdir() Method

The fs.rmdir() method is used to delete a directory at the given path. It can also be used recursively to remove nested directories.Syntax: fs.rmdir( path, options, callback )Parameters: This method accepts three parameters as mentioned above and described below: path: It holds the path of the direc

Node.js fs.stat() Method

The fs.stat() method is used to return information about the given file or directory. It returns an fs.Stat object which has several properties and methods to get details about the file or directory. Syntax:fs.stat( path, options, callback )Parameters: This method accept three parameters as mentione

Node.js fs.mkdtempSync() Method

The fs.mkdtempSync() method is an inbuilt application programming interface of fs module which provides an API for interacting with the file system in a manner closely modeled around standard POSIX functions. The fs.mkdtempSync() method creates a unique temporary directory. This is the synchronous v

Node.js fs.realpath() Method

The fs.realPath() method is used to compute the canonical pathname of the given path. It does so by resolving the ., .. and the symbolic links in the path. Syntax: fs.realpath( path, options, callback ) Parameters: This method accept three parameters as mentioned above and described below: path: It