Método Node.js fs.opendirSync()

El método fs.opendirSync() se utiliza para abrir un directorio en el sistema de archivos de forma síncrona. Devuelve un objeto fs.Dir que se utiliza para representar el directorio. Este objeto contiene varios métodos que se pueden utilizar para acceder al directorio.

Sintaxis:

fs.opendirSync( path[, options] )

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

• ruta: Es un String, Buffer o URL que denota la ruta del directorio que se tiene que abrir.
• opciones: es una string o un objeto que se puede usar para especificar parámetros opcionales que afectarán la salida. Tiene dos parámetros opcionales:
  • codificación: es una string que especifica la codificación de la ruta al abrir el directorio y para las operaciones de lectura posteriores. El valor predeterminado es ‘utf8’.
  • bufferSize: es un número que especifica la cantidad de entradas de directorio que se almacenan en el búfer internamente cuando se lee el directorio. Un valor más alto significa más rendimiento pero conduce a un mayor uso de la memoria. El valor predeterminado es ’32’.

Valor devuelto: Devuelve un objeto fs.Dir que representa el directorio y contiene varios métodos que se pueden utilizar para acceder a él.

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

Ejemplo 1:

// Node.js program to demonstrate the
// fs.opendirSync() method
  
// Import the filesystem module
const fs = require('fs');
  
// Open the directory
console.log("Opening the directory");
let openedDir = fs.opendirSync("example_dir");
  
// Print the pathname of the directory
console.log("\nPath of the directory:", openedDir.path);
  
// Close the directory
console.log("\nClosing the directory");
openedDir.closeSync();

Producción:

Opening the directory

Path of the directory: example_dir

Closing the directory

Ejemplo 2:

// Node.js program to demonstrate the
// fs.opendirSync() method
  
// Import the filesystem module
const fs = require('fs');
  
// Function to get current filenames
// in directory
filenames = fs.readdirSync("example_dir");
  
console.log("\nCurrent filenames in directory:");
filenames.forEach((file) => {
  console.log(file);
});
  
// Open the directory
openedDir = fs.opendirSync("example_dir");
  
// Print the pathname of the directory
console.log("\nPath of the directory:", openedDir.path);
  
// Read the files in the directory
// as fs.Dirent objects
console.log("First Dirent:", openedDir.readSync());
console.log("Next Dirent:", openedDir.readSync());
console.log("Next Dirent:", openedDir.readSync());

Producción:

Current filenames in directory:
example1.txt
example2.txt

Path of the directory: example_dir
First Dirent: Dirent { name: 'example1.txt', [Symbol(type)]: 1 }
Next Dirent: Dirent { name: 'example2.txt', [Symbol(type)]: 1 }
Next Dirent: null

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