Node.js | fs.unlink() Method

The fs.unlink() method is used to remove a file or symbolic link from the filesystem. This function does not work on directories, therefore it is recommended to use fs.rmdir() to remove a directory.

Syntax:

fs.unlink( path, callback )

Parameters: This method accepts two parameters as mentioned above and described below:

  • path: It is a string, Buffer or URL which represents the file or symbolic link which has to be removed.
  • callback: It is a function that would be called when the method is executed.
    • err: It is an error that would be thrown if the method fails.

Below examples illustrate the fs.unlink() method in Node.js:

Example 1: This example removes a file from the filesystem.



filter_none

edit
close

play_arrow

link
brightness_4
code

// Node.js program to demonstrate the
// fs.unlink() method
  
// Import the filesystem module
const fs = require('fs');
  
// Get the files in current diectory
// before deletion
getFilesInDirectory();
  
// Delete example_file.txt
fs.unlink("example_file.txt", (err => {
  if (err) console.log(err);
  else {
    console.log("\nDeleted file: example_file.txt");
  
    // Get the files in current diectory
    // after deletion
    getFilesInDirectory();
  }
}));
  
// Function to get current filenames
// in directory with specific extension
function getFilesInDirectory() {
  console.log("\nFiles present in directory:");
  let files = fs.readdirSync(__dirname);
  files.forEach(file => {
    console.log(file);
  });
}

chevron_right


Output:

Files present in directory:
example_file.txt
index.js
package.json

Deleted file: example_file.txt

Files present in directory:
index.js
package.json

Example 2: This example removes a symbolic link from the filesystem.

filter_none

edit
close

play_arrow

link
brightness_4
code

// Node.js program to demonstrate the
// fs.unlink() method
  
// Import the filesystem module
const fs = require('fs');
  
// Creating symlink to file
fs.symlinkSync(__dirname + "\\example_file.txt", "symlinkToFile");
console.log("\nSymbolic link to example_file.txt created");
  
// Function to get current filenames
// in directory with specific extension
getFilesInDirectory();
  
// Deleting symbolic link to example_file.txt
// Delete example_file.txt
fs.unlink("symlinkToFile", (err => {
  if (err) console.log(err);
  else {
    console.log("\nDeleted Symbolic Link: symlinkToFile");
  
    // Get the files in current diectory
    // after deletion
    getFilesInDirectory();
  }
}));
  
// Function to get current filenames
// in directory with specific extension
function getFilesInDirectory() {
  console.log("\nFiles present in directory:");
  let files = fs.readdirSync(__dirname);
  files.forEach(file => {
    console.log(file);
  });
}

chevron_right


Output:

Symbolic link to example_file.txt created

Files present in directory:
example_file.txt
index.js
package.json
symlinkToFile

Deleted Symbolic Link: symlinkToFile

Files present in directory:
example_file.txt
index.js
package.json

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




My Personal Notes arrow_drop_up

Check out this Author's contributed articles.

If you like GeeksforGeeks and would like to contribute, you can also write an article using contribute.geeksforgeeks.org or mail your article to contribute@geeksforgeeks.org. See your article appearing on the GeeksforGeeks main page and help other Geeks.

Please Improve this article if you find anything incorrect by clicking on the "Improve Article" button below.


Article Tags :

Be the First to upvote.


Please write to us at contribute@geeksforgeeks.org to report any issue with the above content.