【Node.js24.x】Object::globSync()メソッドの使い方
globSyncメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
globSyncメソッドは、ファイルシステム内から特定のパターンに一致するパス(ファイルやディレクトリ)を同期的に検索し、その結果を配列として返すメソッドです。ここでいう「パターン」とは、ワイルドカード文字(例えば * は任意の文字列、? は任意の一文字、** は任意の深さのディレクトリとファイル)を使用して表現される検索条件を指します。
このメソッドの「Sync」は、処理が同期的に実行されることを意味しており、ファイル検索が完了するまでプログラムの実行をブロックします。そのため、結果はすぐに戻り値として得られます。例えば、特定の拡張子を持つすべての設定ファイルを一括で見つけ出したり、特定の名前規則に従うログファイルをリストアップしたりする際に非常に便利です。
同期処理であるため、大量のファイルや広範囲のディレクトリを検索する際には、アプリケーション全体の応答性に影響を与える可能性があります。特にユーザーインターフェースを持つアプリケーションでは、処理中にUIが一時的にフリーズする可能性があるため、そのような場合には非同期で動作する同等のメソッドの利用も検討することが推奨されます。globSyncメソッドは、スクリプトやバッチ処理など、実行順序の明確さが求められる場面で特に役立ちます。
構文(syntax)
import { globSync } from 'glob';
const files = globSync('**/*.js');
引数(parameters)
pattern, options
- pattern: string | string[]: 検索するファイルパスのパターン。ワイルドカード(例:
*,**,?)を使用できます。 - options: object: 検索オプションを指定するオブジェクト。
戻り値(return)
戻り値なし
戻り値はありません