【Node.js24.x】Object::linkSync()メソッドの使い方
linkSyncメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
linkSyncメソッドは、Node.jsのファイルシステム操作において、指定された既存のファイルに対して新しいハードリンクを同期的に作成するメソッドです。ハードリンクとは、同じファイルの実体を複数の異なるパス（名前）から参照できるようにする機能で、これにより、一つのファイルがシステム上で異なる名前を持つことが可能になります。どちらかのパスからファイルを削除しても、もう一方のパスが残っていればファイルの実体は保持され続けます。
このメソッドは、リンク元となる既存ファイルのパスと、新しく作成するハードリンクのパスの二つを引数として取ります。処理は同期的に実行されるため、ハードリンクの作成が完了するまでNode.jsのプログラム実行を一時停止させます。そのため、大規模なファイルシステム操作を行う際には、アプリケーションの応答性に影響を与える可能性がある点に注意が必要です。
linkSyncメソッドは通常、Node.jsのfs（ファイルシステム）モジュールの一部として提供されており、fs.linkSync(既存ファイルのパス, 新しいリンクのパス)という形式で利用されます。これは、ファイルのバックアップ、異なるディレクトリから同じ設定ファイルを参照するといった、複数の場所から一つのデータにアクセスしたいシナリオで活用できます。ファイルの指定が誤っている場合や、アクセス権限がない場合など、何らかのエラーが発生した際には例外がスローされます。
構文(syntax)
1const fs = require('node:fs'); 2 3fs.linkSync('path/to/existing/file.txt', 'path/to/new/link.txt');
引数(parameters)
existingPath, newPath
- existingPath: string: リンク元の既存のパスを指定します。
- newPath: string: 新しく作成するシンボリックリンクのパスを指定します。
戻り値(return)
戻り値なし
戻り値はありません