--- title: Storage.key() slug: Web/API/Storage/key tags: - API - Method - Reference - Storage - Web Storage translation_of: Web/API/Storage/key ---

{{APIRef}}

{{domxref("Storage")}} インターフェイスの key() メソッドは数値 n を渡すと、ストレージ内で n 番目のキーの名称を返します。キーの順序はユーザエージェント依存であり、この順序に頼るべきではありません。

構文

var aKeyName = storage.key(key);

引数

key
名称を取得したいキーの番号を表す整数。これは 0 から始まるインデックスです。

戻り値

キーの名称を持つ {{domxref("DOMString")}}。

以下の関数は、ローカルストレージのキー全体に対して反復処理を行います:

function forEachKey(callback) {
  for (var i = 0; i < localStorage.length; i++) {
    callback(localStorage.key(i));
  }
}

注記: 実際の例として、Web Storage Demo をご覧ください。

仕様

仕様書 策定状況 コメント
{{SpecName('Web Storage', '#dom-storage-key', 'key()')}} {{Spec2('Web Storage')}}  

ブラウザ実装状況

{{Compat("api.Storage.key")}}

関連情報