Método Node.js fs.rmSync()

El método fs.rmSync() se utiliza para eliminar de forma síncrona un archivo en la ruta dada. También se puede utilizar de forma recursiva para eliminar el directorio configurando el objeto de opciones. Devuelve indefinido.

Sintaxis:

fs.rmSync( path, options );

Parámetros: este método acepta dos parámetros, como se mencionó anteriormente y se describe a continuación:

• ruta: contiene la ruta del archivo que se debe eliminar. Puede ser una string, un búfer o una URL.
• opciones: Es un objeto que se puede usar para especificar parámetros opcionales que afectarán la operación de la siguiente manera:
  • force: Es un valor booleano. Las excepciones se ignorarán si la ruta no existe.
  • recursivo: es un valor booleano que especifica si se realiza la eliminación recursiva del directorio. En este modo, los errores no se informan si no se encuentra la ruta especificada y la operación se vuelve a intentar si falla. El valor predeterminado es falso.

Los siguientes ejemplos ilustran el método fs.rmSync() en Node.js:

Ejemplo 1: este ejemplo utiliza el método fs.rmSync() para eliminar un archivo.

Nombre de archivo: index.js

// Import necessary modules
let fs = require('fs');
  
// List files before deleting
getCurrentFilenames();
  
fs.rmSync('./dummy.txt');
  
// List files after deleting
getCurrentFilenames();
  
// This will list all files in current directory
function getCurrentFilenames() { 
    console.log("\nCurrent filenames:"); 
    fs.readdirSync(__dirname).forEach(file => { 
        console.log(file); 
    }); 
    console.log(""); 
}

Ejecute el archivo index.js con el siguiente comando:

node index.js

Producción:

Current filenames:
dummy.txt
index.js
node_modules
package-lock.json
package.json


Current filenames:
index.js
node_modules
package-lock.json
package.json

Ejemplo 2: este ejemplo utiliza el método fs.rmSync() con el parámetro recursivo para eliminar directorios.

Nombre de archivo: index.js

// Import the filesystem module 
const fs = require('fs'); 
    
// List the files in current directory 
getCurrentFilenames(); 
  
// Using the recursive option to delete directory 
fs.rmSync("./build", { recursive: true });
  
// List files after delete 
getCurrentFilenames(); 
    
// List all files in current directory
function getCurrentFilenames() { 
  console.log("\nCurrent filenames:"); 
  fs.readdirSync(__dirname).forEach(file => { 
    console.log(file); 
  }); 
  console.log("\n"); 
}

Ejecute el archivo index.js con el siguiente comando:

node index.js

Producción:

Current filenames:
build
index.js
node_modules     
package-lock.json
package.json

Current filenames:
index.js
node_modules
package-lock.json
package.json

Referencia: https://nodejs.org/api/fs.html#fs_fs_rmsync_path_options