fs extra npm (Como funciona para desenvolvedores)

Expandindo as funcionalidades do módulo fs nativo, o fs-extra é um módulo de sistema de arquivos aprimorado for Node.js É uma escolha popular entre os desenvolvedores, oferecendo uma gama de técnicas poderosas e práticas para gerenciar arquivos e diretórios. Em comparação com o módulo fs original, o fs-extra oferece os seguintes recursos, além de suporte adicional a promessas nos métodos padrão do fs:

Operações de Arquivo Aprimoradas

• Copiar: fs.copy(src, dest): Copia diretórios e arquivos, incluindo conteúdo aninhado, da origem para o destino.
• Mover: fs.move(src, dest): Transfere pastas e arquivos, oferecendo a opção de renomeá-los.
• Remover: fs.remove(path): Exclui pastas e arquivos recursivamente.

Operações de diretório

• Garantir diretório: fs.ensureDir(path): Verifica se um diretório já existe; Caso contrário, cria o diretório.
• Diretório vazio: fs.emptyDir(path): Exclui o conteúdo de um diretório, mas deixa o próprio diretório intacto.
• Verificar se o arquivo já existe: fs.ensureFile(path): Verifica se o arquivo já existe; Caso contrário, cria o arquivo.

Manipulação de JSON

• Ler JSON: fs.readJson(path): Lê um arquivo JSON e analisa seu conteúdo.
• Escrever JSON: fs.writeJson(path, data): Escreve um objeto JavaScript em um arquivo como JSON.

Suporte de Promessa

• API baseada em Promises: A maioria dos métodos retorna Promises, facilitando a escrita de código assíncrono com a sintaxe async/await.

Compatibilidade com versões anteriores

• Suporte completo ao módulo fs: o fs-extra inclui todos os métodos padrão do módulo fs nativo, tornando-o um substituto direto com total compatibilidade retroativa.

Métodos de conveniência

• Arquivo de saída: fs.outputFile(path, data): Cria diretórios se nenhum já existir e grava dados em um arquivo.
• Saída JSON: fs.outputJson(path, data): Cria pastas caso ainda não existam antes de gravar um objeto JavaScript em formato JSON em um arquivo.
• Ler arquivo: fs.readFile(path): Lê o conteúdo de um arquivo.
• Escrever arquivo: fs.writeFile(path, data): Escreve dados em um arquivo.
• Path Exists: fs.pathExists(path): Verifica se um arquivo ou diretório existe no caminho fornecido.

Criar links simbólicos

• Garantir link simbólico: fs.ensureSymlink(srcpath, dstpath): Verifica se um link simbólico está presente e, caso contrário, cria um.

Para ilustrar o uso do fs-extra, abra index.js em seu editor de texto preferido e adicione o seguinte código de exemplo.

// 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();

O trecho de código acima ilustra os recursos do módulo de sistema de arquivos aprimorado do Node.js , a biblioteca fs-extra . O script implementa um método assíncrono chamado performFileOperations para realizar diversas operações de arquivo após importar fs-extra . Utilizando o método fs.ensureDir() , ele primeiro verifica se existe um diretório com o nome "exampleDir". Em seguida, usando o método fs.outputFile() , ele cria um arquivo chamado "exampleFile.txt" dentro deste diretório e escreve o texto "Olá, mundo!" nele. Usando fs.readFile() , o script lê o conteúdo do arquivo e o registra no console.

Saída do console

Além disso, utiliza funções recursivas como fs.copy() para copiar o arquivo para "copyOfExampleFile.txt" e, em seguida, usa fs.move() para realocar essa cópia para "movedExampleFile.txt". Em seguida, a função fs.remove() é usada para excluir o arquivo realocado. O script utiliza a função fs.ensureFile() para verificar a existência do arquivo "newFile.txt" e a função fs.writeJson() para escrever um objeto JSON no arquivo "data.json". Por fim, utiliza a função fs.readJson() para ler os dados JSON do arquivo e exibi-los no console. Os erros que ocorrem durante esses procedimentos são detectados e registrados. A utilidade e a facilidade de uso do fs-extra para gerenciamento de arquivos e diretórios no Node.js são demonstradas chamando a função performFileOperations para realizar essas operações uma após a outra.

SAÍDA

Geração de PDF a partir de HTML

Converter HTML, CSS e JavaScript para PDF. Suporta padrões web modernos como media queries e design responsivo, o que é útil para usar HTML e CSS para decorar dinamicamente documentos PDF, relatórios e faturas.

Edição de PDF

• Adicione texto, imagens e outros materiais a PDFs existentes.
• Extrair texto e imagens de arquivos PDF.
• Combinar vários PDFs em um único arquivo.
• Dividir arquivos PDF em vários documentos distintos.
• Adicione cabeçalhos, rodapés, anotações e marcas d'água.

Desempenho e confiabilidade

Os atributos de projeto incluem alto desempenho e confiabilidade em contextos industriais. Ele lida facilmente com grandes conjuntos de documentos.

Para demonstrar a utilização conjunta de fs-extra e IronPDF , abra index.js em seu editor de texto preferido e adicione o seguinte 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();

O exemplo de código Node.js acima combina o IronPDF para criar e gerenciar arquivos PDF com o fs-extra para operações avançadas do sistema de arquivos. Começa por garantir que um diretório chamado "output" exista, utilizando a função fs.ensureDir() . Um diretório é um agrupamento hierárquico de diretórios e arquivos. A estrutura do PDF que será criado é definida pelo conteúdo HTML, que está contido em htmlContent . Ele usa a classe PdfDocument do IronPDF para inserir o conteúdo HTML com o método fromHtml() e salva o PDF resultante em "output/sample.pdf" usando a função saveAs() .

SAÍDA

Em seguida, o fs-extra é usado para continuar as operações de arquivo: fs.readFile() obtém o conteúdo do PDF para rastrear seu tamanho. fs.copy() duplica o arquivo gerado "output/sample.pdf" para "output/copied_sample.pdf", então o método fs.move() move essa cópia para "output/moved_sample.pdf" e, finalmente, remove o PDF original. O tratamento de erros por meio de blocos try-catch garante que quaisquer problemas que surjam durante a execução de métodos ou atividades do sistema de arquivos sejam devidamente capturados e registrados. Em resumo, esta configuração demonstra como aprimorar as operações com arquivos usando o fs-extra e como criar e manipular PDFs com facilidade em aplicações Node.js utilizando o IronPDF.

PDF de saída