【Node.js24.x】Object::lstat()メソッドの使い方
lstatメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
lstatメソッドは、ファイルシステム上の指定されたパスについて、その状態情報を取得するメソッドです。このメソッドは、ファイルの種類、サイズ、作成日時、最終更新日時といった様々なメタデータを提供します。
シンボリックリンクを扱う際には、特に注意が必要です。一般的なstatメソッドがシンボリックリンクの「指し示す先」の情報を取得するのに対し、lstatメソッドは「シンボリックリンクそのもの」の情報を取得します。これにより、リンク先のファイルではなく、シンボリックリンク自体の属性を確認したい場合や、パスがシンボリックリンクであるかを判別したい場合に非常に有用です。
このメソッドは非同期で動作するため、ファイルシステムへのアクセス中にプログラムの他の処理を妨げることがなく、効率的な処理を実現します。
構文(syntax)
1import { lstat } from 'node:fs/promises'; 2 3async function getFileOrSymlinkStats() { 4 try { 5 const stats = await lstat('path/to/file_or_symlink'); 6 } catch (error) { 7 console.error(error); 8 } 9} 10 11getFileOrSymlinkStats();
引数(parameters)
path, options, callback
- path: string: 統計情報を取得したいファイルまたはディレクトリのパス
- options: object: オプションを指定するオブジェクト (省略可能)
- callback: function: 処理完了後に実行されるコールバック関数 (省略可能)
戻り値(return)
戻り値なし
戻り値はありません