fs extra npm (開発者向けのしくみ)

ネイティブfsモジュールの機能を拡張し、fs-extraはNode.js用の改良されたファイルシステムモジュールです。 強力で実用的なファイルとディレクトリを管理する技術を提供するため、開発者に人気があります。 元のfsモジュールと比べて、fs-extraは次の機能を誇り、標準fsメソッドへの追加の約束サポートがされています。

強化されたファイル操作

• コピー: fs.copy(src, dest): ディレクトリやファイル（ネストされた内容も含む）をソースからデスティネーションにコピーします。
• 移動: fs.move(src, dest): フォルダーやファイルを移動し、名前の変更を行うオプションを提供します。
• 削除: fs.remove(path): フォルダーやファイルを再帰的に削除します。

ディレクトリ操作

• ディレクトリの確保: fs.ensureDir(path): 既にディレクトリが存在するかどうかを確認します； 存在しない場合は、ディレクトリを作成します。
• ディレクトリの空にする: fs.emptyDir(path): ディレクトリの内容を削除しますが、ディレクトリ自体はそのまま残します。
• ファイルの確保: fs.ensureFile(path): 既にファイルが存在するかどうかを確認します； 存在しない場合はファイルを作成します。

JSON処理

• JSONを読む: fs.readJson(path): JSONファイルを読み、それを解析します。
• JSONに書く: fs.writeJson(path, data): JavaScriptオブジェクトをファイルにJSONとして書き込みます。

プロミスサポート

• プロミスベースのAPI: ほとんどのメソッドはPromisesを返すため、非同期コードをasync/await構文で書くことを容易にします。

後方互換性

• フルfsモジュールサポート: fs-extraはネイティブfsモジュールのすべての標準メソッドを含んでおり、完全な後方互換性を持つ置き換えとして利用できます。

便利なメソッド

• ファイルを書き出す: fs.outputFile(path, data): 既に存在していない場合はディレクトリを作成し、ファイルにデータを書き込みます。
• JSONを書き出す: fs.outputJson(path, data): 既に存在していない場合はフォルダーを作成し、JavaScriptオブジェクトをJSONとしてファイルに書き込みます。
• ファイルを読む: fs.readFile(path): ファイルの内容を読み込みます。
• ファイルを書く: fs.writeFile(path, data): ファイルにデータを書き込みます。
• パスの存在確認: fs.pathExists(path): 指定されたパスにファイルまたはディレクトリが存在するかどうかを確認します。

シンボリックリンクの作成

• シンボリックリンクの確保: fs.ensureSymlink(srcpath, dstpath): シンボリックリンクが存在するかどうかを確認し、存在しない場合は作成します。

fs-extraの使用を示すために、お好きなテキストエディタでindex.jsを開き、次のサンプルコードを追加します。

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

上のコードスニペットは、改良されたNode.jsファイルシステムモジュール、fs-extraライブラリの機能を示しています。 スクリプトはperformFileOperationsという非同期メソッドを実装し、fs-extraのインポート後にいくつかのファイル操作を行います。 fs.ensureDir()メソッドを使用して、まず「exampleDir」という名前のディレクトリが存在することを確認します。 次に、fs.outputFile()メソッドを使用して、このディレクトリ内に「exampleFile.txt」というファイルを作成し、テキスト「Hello, world!」を書き込みます。 fs.readFile()を使用して、スクリプトはファイルの内容を読み取り、それをコンソールにログ出力します。

Console Output

さらに、再帰的な関数を使用して、fs.copy()を使用してファイルを「copyOfExampleFile.txt」にコピーし、「movedExampleFile.txt」にこのコピーを移動します。 その後、fs.remove()を使用して移動したファイルを削除します。スクリプトはfs.ensureFile()関数を使用して「newFile.txt」の存在を確認し、fs.writeJson()を使用してJavaScriptオブジェクトを「data.json」に書き込みます。最後に、fs.readJson()を使用してファイルからJSONデータを読み取り、それをコンソールにログ出力します。 これらの手順中に発生したエラーはキャッチされ、ログに記録されます。 Node.js内のファイルとディレクトリの管理におけるfs-extraの有用性と使いやすさはこれらの操作を順番に実行する関数performFileOperationsを呼び出すことによって示されています。

出力

HTMLからのPDF生成

HTML、CSS、JavaScriptをPDFに変換します。 メディアクエリやレスポンシブデザインなどの現代的なWeb標準に対応しており、HTMLとCSSを使用して動的にPDF文書、レポート、請求書を装飾するのに便利です。

PDF編集

• 既存のPDFにテキスト、画像、その他の資料を追加します。
• PDFファイルからテキストと画像を抽出します。
• 複数のPDFを1つのファイルに結合します。
• PDFファイルを複数の独立した文書に分割します。
• ヘッダー、フッター、注釈、ウォーターマークを追加します。

性能と信頼性

工業的文脈での高性能と高信頼性を備えたデザイン属性です。 大規模なドキュメントセットを簡単に処理します。

fs-extraとIronPDFを一緒に利用することを示すために、お好きなテキストエディタでindex.jsを開き、次のコードを追加します。

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

上記のNode.jsコードサンプルは、高度なファイルシステム操作のためのfs-extraとPDFファイルの作成と管理のためのIronPDFを組み合わせています。 最初にfs.ensureDir()関数を使用して「output」というディレクトリが存在することを確保します。 ディレクトリはディレクトリとファイルを階層的に集めたものです。 作成されるPDFの構造はhtmlContentに含まれたHTMLコンテンツによって定義されます。 IronPDFのPdfDocumentクラスを使用してHTMLコンテンツを挿入するためにfromHtml()メソッドを使用し、生成されたPDFを「output/sample.pdf」にsaveAs()関数で保存します。

出力

ソース：fs extra npm（開発者向けの動作方法）：図5 - fs-extraとIronPDFライブラリを組み合わせたNode.jsアプリケーションのコンソール出力。 プログラムは、ファイルとディレクトリの操作にfs-extraライブラリを、HTMLコンテンツをPDF文書に変換するためにIronPDFライブラリを使用します。

fs-extraを使用してファイル操作を続行します：fs.readFile()はPDFの内容を取得し、そのサイズを追跡します。fs.copy()は生成された「output/sample.pdf」を「output/copied_sample.pdf」に複製した後、fs.move()メソッドでこのコピーを「output/moved_sample.pdf」に移動し、最後に元のPDFを削除します。 try-catchブロックによるエラーハンドリングにより、fsメソッドやアクティビティの実行中に発生する問題が適切にキャッチされ、記録されることが保証されます。 全体として、この構成はfs-extraでファイル操作を強化し、Node.jsアプリケーション内でIronPDFを使用してPDFを簡単に作成および操作するための方法を示しています。

出力 PDF