【Node.js24.x】Object::symlink()メソッドの使い方
symlinkメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
symlinkメソッドは、ファイルシステム上にシンボリックリンクを作成するメソッドです。シンボリックリンクとは、あるファイルやディレクトリへの参照（ショートカットのようなもの）を別の場所に作成する仕組みです。このメソッドを利用することで、物理的なファイルやディレクトリをコピーすることなく、指定したパスから元のデータにアクセスできるようになります。
このメソッドは主に、アプリケーションのデプロイメントや開発環境の構築において、設定ファイルを特定のパスにリンクさせたり、共通のライブラリやリソースを複数のプロジェクトから参照させたりする際に活用されます。例えば、ウェブサーバーが特定のディレクトリを公開する際に、そのディレクトリに実際のデータがある別の場所へのシンボリックリンクを配置するといった使い方ができます。
symlinkメソッドは通常、シンボリックリンクが指し示す元のパス（ターゲット）、作成するシンボリックリンクのパス（リンクパス）、そしてリンクのタイプ（ファイルまたはディレクトリ）を引数として受け取ります。非同期で動作し、リンクの作成処理が完了した後、その結果を処理するためのコールバック関数を呼び出します。これにより、ファイルシステム操作中にプログラムの実行がブロックされることなく、スムーズな処理が可能です。ただし、シンボリックリンクの作成には適切なファイルシステム権限が必要であり、また、元のターゲットが存在しない場合、シンボリックリンクは機能しない点に注意が必要です。
構文(syntax)
1import { promises as fs } from 'node:fs'; 2 3await fs.symlink(originalPath, linkPath);
引数(parameters)
target, path, type = 'file', callback
- target: string: シンボリックリンクが参照する元のファイルまたはディレクトリのパス
- path: string: 作成するシンボリックリンクのパス
- type: string = 'file': シンボリックリンクの種類 ('file' または 'dir')。デフォルトは 'file' です。
- callback: function (err): シンボリックリンク作成処理が完了した後に呼び出されるコールバック関数。エラーが発生した場合は err にエラーオブジェクトが格納されます。
戻り値(return)
戻り値なし
戻り値はありません