fs extra npm (Cómo funciona para desarrolladores)

Ampliando las características del módulo nativo fs, fs-extra es un módulo del sistema de archivos mejorado para Node.js. Es una opción popular para los desarrolladores, ofreciendo una gama de técnicas poderosas y prácticas para la gestión de archivos y directorios. Comparado con el módulo fs original, fs-extra cuenta con las siguientes características, junto con soporte de promesas añadido a los métodos estándar de fs:

Operaciones de archivos mejoradas

• Copiar: fs.copy(src, dest): Copia directorios y archivos, incluyendo contenidos anidados, desde la fuente hasta el destino.
• Mover: fs.move(src, dest): Transfiere carpetas y archivos, proporcionando una opción para renombrarlos.
• Eliminar: fs.remove(path): Elimina carpetas y archivos de manera recursiva.

Operaciones de directorio

• Asegurar Directorio: fs.ensureDir(path): Verifica si un directorio ya existe; si no, crea el directorio.
• Vaciar Directorio: fs.emptyDir(path): Elimina el contenido de un directorio pero deja intacto el directorio en sí.
• Asegurar Archivo: fs.ensureFile(path): Verifica si un archivo ya existe; si no, crea el archivo.

Manejo de JSON

• Leer JSON: fs.readJson(path): Lee un archivo JSON y analiza su contenido.
• Escribir JSON: fs.writeJson(path, data): Escribe un objeto JavaScript en un archivo como JSON.

Promise Support

• API Basada en Promesas: La mayoría de los métodos devuelven Promesas, facilitando la escritura de código asincrónico con la sintaxis async/await.

Compatibilidad con versiones anteriores

• Compatibilidad Completa con el Módulo fs: fs-extra incluye todos los métodos estándar del módulo fs nativo, lo que lo convierte en un reemplazo directo con compatibilidad retroactiva completa.

Métodos de conveniencia

• Output File: fs.outputFile(path, data): Crea directorios si no existen y escribe datos en un archivo.
• Output JSON: fs.outputJson(path, data): Crea carpetas si no existen antes de escribir un objeto JavaScript en JSON en un archivo.
• Leer Archivo: fs.readFile(path): Lee el contenido de un archivo.
• Escribir Archivo: fs.writeFile(path, data): Escribe datos en un archivo.
• Path Exists: fs.pathExists(path): Verifica si un archivo o directorio existe en la ruta dada.

Crear enlaces simbólicos

• Asegurar Enlace Simbólico: fs.ensureSymlink(srcpath, dstpath): Verifica si hay un enlace simbólico presente, y si no, crea uno.

Para ilustrar el uso de fs-extra, abre index.js en tu editor de texto preferido y añade el siguiente código de ejemplo.

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

// Asynchronous function to perform various file operations
async function performFileOperations() {
  try {
    // Ensure a directory exists; create it if it doesn't
    await fs.ensureDir('exampleDir');

    // Create a file and write some data to it
    await fs.outputFile('exampleDir/exampleFile.txt', 'Hello, world!');

    // Read the file's content
    const data = await fs.readFile('exampleDir/exampleFile.txt', 'utf-8');
    console.log('File Content:', data);

    // Recursively copy the file
    await fs.copy('exampleDir/exampleFile.txt', 'exampleDir/copyOfExampleFile.txt');

    // Move the file to a new location
    await fs.move('exampleDir/copyOfExampleFile.txt', 'exampleDir/movedExampleFile.txt');

    // Remove the file
    await fs.remove('exampleDir/movedExampleFile.txt');

    // Ensure a file exists; create it if it doesn't
    await fs.ensureFile('exampleDir/newFile.txt');

    // Write JSON data to a file
    const jsonData = { name: 'John Doe', age: 30 };
    await fs.writeJson('exampleDir/data.json', jsonData);

    // Read JSON data from a file
    const jsonFileContent = await fs.readJson('exampleDir/data.json');
    console.log('JSON File Content:', jsonFileContent);
  } catch (err) {
    console.error('Error during file operations:', err);
  }
}

// Execute the file operations
performFileOperations();

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

// Asynchronous function to perform various file operations
async function performFileOperations() {
  try {
    // Ensure a directory exists; create it if it doesn't
    await fs.ensureDir('exampleDir');

    // Create a file and write some data to it
    await fs.outputFile('exampleDir/exampleFile.txt', 'Hello, world!');

    // Read the file's content
    const data = await fs.readFile('exampleDir/exampleFile.txt', 'utf-8');
    console.log('File Content:', data);

    // Recursively copy the file
    await fs.copy('exampleDir/exampleFile.txt', 'exampleDir/copyOfExampleFile.txt');

    // Move the file to a new location
    await fs.move('exampleDir/copyOfExampleFile.txt', 'exampleDir/movedExampleFile.txt');

    // Remove the file
    await fs.remove('exampleDir/movedExampleFile.txt');

    // Ensure a file exists; create it if it doesn't
    await fs.ensureFile('exampleDir/newFile.txt');

    // Write JSON data to a file
    const jsonData = { name: 'John Doe', age: 30 };
    await fs.writeJson('exampleDir/data.json', jsonData);

    // Read JSON data from a file
    const jsonFileContent = await fs.readJson('exampleDir/data.json');
    console.log('JSON File Content:', jsonFileContent);
  } catch (err) {
    console.error('Error during file operations:', err);
  }
}

// Execute the file operations
performFileOperations();

El fragmento de código anterior ilustra las características del módulo de sistema de archivos mejorado de Node.js, la biblioteca fs-extra. El script implementa un método asincrónico llamado performFileOperations para realizar varias operaciones con archivos después de importar fs-extra. Usando el método fs.ensureDir(), primero verifica que existe un directorio con el nombre "exampleDir". Luego, usando el método fs.outputFile(), crea un archivo llamado "exampleFile.txt" dentro de este directorio y escribe el texto "¡Hola, mundo!" en él. Usando fs.readFile(), el script lee el contenido del archivo y lo registra en la consola.

Salida de consola

Adicionalmente, usa funciones recursivas como fs.copy() para copiar el archivo a "copyOfExampleFile.txt" y luego usa fs.move() para reubicar esta copia a "movedExampleFile.txt". Luego, fs.remove() se usa para eliminar el archivo reubicado. El script usa la función fs.ensureFile() para verificar la existencia de "newFile.txt" y fs.writeJson() para escribir un objeto JSON en el archivo "data.json". Por último, usa fs.readJson() para leer los datos JSON del archivo y registrarlos en la consola. Los errores que ocurren durante estos procedimientos se detectan y registran. La utilidad y facilidad de uso de fs-extra para la gestión de archivos y directorios en Node.js es demostrada luego llamando a la función performFileOperations para llevar a cabo estas operaciones una tras otra.

PRODUCCIÓN

Generación de PDF a partir de HTML

Convertir HTML, CSS y JavaScript a PDF. Soporta estándares web modernos como consultas de medios y diseño responsivo, lo cual es conveniente para usar HTML y CSS para decorar dinámicamente documentos PDF, informes y facturas.

Edición de PDF

• Añadir texto, imágenes y otros materiales a PDFs existentes.
• Extraer texto e imágenes de archivos PDF.
• Fusionar varios PDFs en un solo archivo.
• Dividir archivos PDF en varios documentos distintos.
• Añadir encabezados, pies de página, anotaciones y marcas de agua.

Rendimiento y fiabilidad

Los atributos de diseño incluyen alto rendimiento y fiabilidad en contextos industriales. Maneja fácilmente conjuntos de documentos grandes.

Para demostrar el uso de fs-extra e IronPDF juntos, abre index.js en tu editor de texto preferido y añade el siguiente código:

// Import fs-extra and IronPDF libraries
const fs = require('fs-extra');
const IronPdf = require("@ironsoftware/ironpdf");

const document = IronPdf.PdfDocument;
var config = IronPdf.IronPdfGlobalConfig;
config.setConfig({ licenseKey: '' }); // Set your IronPDF license key here

// Asynchronous function to create and manage PDF files
async function createAndManagePDF() {
  try {
    // Ensure the parent directory exists
    const outputDir = 'output';
    await fs.ensureDir(outputDir);

    // Define the HTML content for the PDF
    const htmlContent = `
      <html>
        <head>
          <title>Sample PDF</title>
        </head>
        <body>
          <h1>Hello, world!</h1>
          <p>This is a sample PDF generated using IronPDF and fs-extra.</p>
        </body>
      </html>
    `;

    // Initialize IronPDF and generate a PDF from the HTML content
    let pdf = await document.fromHtml(htmlContent);
    const pdfPath = `${outputDir}/sample.pdf`;
    await pdf.saveAs(pdfPath);
    console.log('PDF generated successfully:', pdfPath);

    // Read the PDF file and check its size
    const pdfData = await fs.readFile(pdfPath);
    console.log('PDF file size:', pdfData.length);

    // Copy the PDF file
    const copiedPdfPath = `${outputDir}/copied_sample.pdf`;
    await fs.copy(pdfPath, copiedPdfPath);
    console.log('PDF copied successfully:', copiedPdfPath);

    // Move the copied PDF file
    const movedPdfPath = `${outputDir}/moved_sample.pdf`;
    await fs.move(copiedPdfPath, movedPdfPath);
    console.log('PDF moved successfully:', movedPdfPath);

    // Remove the original PDF file
    await fs.remove(pdfPath);
    console.log('Original PDF removed successfully:', pdfPath);
  } catch (err) {
    console.error('Error during PDF creation and management:', err);
  }
}

// Execute the PDF creation and management operations
createAndManagePDF();

// Import fs-extra and IronPDF libraries
const fs = require('fs-extra');
const IronPdf = require("@ironsoftware/ironpdf");

const document = IronPdf.PdfDocument;
var config = IronPdf.IronPdfGlobalConfig;
config.setConfig({ licenseKey: '' }); // Set your IronPDF license key here

// Asynchronous function to create and manage PDF files
async function createAndManagePDF() {
  try {
    // Ensure the parent directory exists
    const outputDir = 'output';
    await fs.ensureDir(outputDir);

    // Define the HTML content for the PDF
    const htmlContent = `
      <html>
        <head>
          <title>Sample PDF</title>
        </head>
        <body>
          <h1>Hello, world!</h1>
          <p>This is a sample PDF generated using IronPDF and fs-extra.</p>
        </body>
      </html>
    `;

    // Initialize IronPDF and generate a PDF from the HTML content
    let pdf = await document.fromHtml(htmlContent);
    const pdfPath = `${outputDir}/sample.pdf`;
    await pdf.saveAs(pdfPath);
    console.log('PDF generated successfully:', pdfPath);

    // Read the PDF file and check its size
    const pdfData = await fs.readFile(pdfPath);
    console.log('PDF file size:', pdfData.length);

    // Copy the PDF file
    const copiedPdfPath = `${outputDir}/copied_sample.pdf`;
    await fs.copy(pdfPath, copiedPdfPath);
    console.log('PDF copied successfully:', copiedPdfPath);

    // Move the copied PDF file
    const movedPdfPath = `${outputDir}/moved_sample.pdf`;
    await fs.move(copiedPdfPath, movedPdfPath);
    console.log('PDF moved successfully:', movedPdfPath);

    // Remove the original PDF file
    await fs.remove(pdfPath);
    console.log('Original PDF removed successfully:', pdfPath);
  } catch (err) {
    console.error('Error during PDF creation and management:', err);
  }
}

// Execute the PDF creation and management operations
createAndManagePDF();

El ejemplo de código Node.js anterior combina IronPDF para crear y gestionar archivos PDF con fs-extra para operaciones avanzadas del sistema de archivos. Comienza asegurando que un directorio llamado "output" exista usando la función fs.ensureDir(). Un directorio es una agrupación jerárquica de directorios y archivos. La estructura del PDF que se creará es definida por el contenido HTML, que está contenido en htmlContent. Usa la clase PdfDocument de IronPDF para insertar el contenido HTML con el método fromHtml() y guarda el PDF resultante en "output/sample.pdf" usando la función saveAs().

PRODUCCIÓN

fs-extra se usa luego para continuar con operaciones de archivo: fs.readFile() obtiene el contenido del PDF para rastrear su tamaño. fs.copy() duplica el "output/sample.pdf" generado a "output/copied_sample.pdf", luego el método fs.move() mueve esta copia a "output/moved_sample.pdf", y finalmente, elimina el PDF original. El manejo de errores mediante bloques try-catch asegura que cualquier problema que surja durante la ejecución de los métodos o actividades fs se detecte y registre adecuadamente. En general, esta configuración demuestra cómo mejorar las operaciones de archivo con fs-extra y cómo crear y manipular PDFs con facilidad en aplicaciones Node.js usando IronPDF.

SALIDA PDF