【Node.js24.x】Symbol::keyFor()メソッドの使い方
keyForメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
keyForメソッドは、Node.js環境において、グローバルシンボルレジストリに登録されたシンボルに対応するキー（文字列）を取得するメソッドです。シンボルは、プログラム内で一意な識別子として使用されるプリミティブな値です。このメソッドは、引数として渡されたシンボルがグローバルシンボルレジストリに存在するかを確認し、存在する場合は、そのシンボルをレジストリに登録する際に使用された文字列キーを返します。もし引数のシンボルがレジストリに登録されていない場合、このメソッドはundefinedを返します。
特に、Symbol.for()メソッドによって作成され、グローバルシンボルレジストリに登録されたシンボルに対してのみ、keyForメソッドは有効に機能します。Symbol()コンストラクタによって直接作成されたシンボルは、グローバルシンボルレジストリには登録されないため、それらのシンボルに対してkeyForを呼び出してもundefinedが返されます。このメソッドは、既存のシンボルがグローバルに登録されたものであるか、またその登録名が何であるかを確認したい場合に役立ちます。
構文(syntax)
1const registeredSymbol = Symbol.for('uniqueIdentifier'); 2const keyString = Symbol.keyFor(registeredSymbol); 3console.log(keyString);
引数(parameters)
sym
- sym: Symbol: 取得したいシンボルのシンボルオブジェクト
戻り値(return)
string | undefined
Symbol.keyFor() メソッドは、グローバルシンボルレジストリに登録されたシンボルを、そのキー文字列として取得します。シンボルがレジストリに存在しない場合は undefined を返します。