StorageArea

StorageArea インターフェースは browser.storage API で使用されます。

メソッド

clear()

browser.storage.StorageArea.clear(): Promise<void>

ストレージからすべてのアイテムを削除します。

戻り値

  • Promise<void>

    Chrome 95 以降 Chrome 148 以降の browser.*

    成功時に解決されるか、失敗時に拒否される Promise。

get()

browser.storage.StorageArea.get(
  keys?: string | string[] | object,
): Promise<object>

ストレージから 1 つ以上のアイテムを取得します。

パラメータ

  • 鍵

    string | string[] | object 省略可

    取得する単一のキー、取得するキーのリスト、またはデフォルト値を指定する辞書（オブジェクトの説明を参照）。空のリストまたはオブジェクトは、空の結果オブジェクトを返します。null を渡して、ストレージのコンテンツ全体を取得します。

戻り値

  • Promise<object>

    Chrome 95 以降 Chrome 148 以降の browser.*

    リクエストされたアイテムの Key-Value マップを含むオブジェクトで解決される Promise。失敗した場合は拒否されます。

getBytesInUse()

browser.storage.StorageArea.getBytesInUse(
  keys?: string | string[],
): Promise<number>

1 つ以上のアイテムで使用されている容量（バイト単位）を取得します。

パラメータ

  • 鍵

    string | string[] 省略可

    合計使用量を取得する単一のキーまたはキーのリスト。空のリストは 0 を返します。null を渡して、すべてのストレージの合計使用量を取得します。

戻り値

  • Promise<number>

    Chrome 95 以降 Chrome 148 以降の browser.*

    ストレージで使用されている容量を解決する Promise。失敗した場合は拒否されます。

getKeys()

Chrome 130 以降 Chrome 148 以降の browser.* 
browser.storage.StorageArea.getKeys(): Promise<string[]>

ストレージからすべてのキーを取得します。

戻り値

  • Promise<string[]>

    ストレージキーで解決される Promise。失敗した場合は拒否されます。

remove()

browser.storage.StorageArea.remove(
  keys: string | string[],
): Promise<void>

ストレージから 1 つ以上のアイテムを削除します。

パラメータ

  • 鍵

    string | string[]

    削除するアイテムの単一のキーまたはキーのリスト。

戻り値

  • Promise<void>

    Chrome 95 以降 Chrome 148 以降の browser.*

    成功時に解決されるか、失敗時に拒否される Promise。

set()

browser.storage.StorageArea.set(
  items: object,
): Promise<void>

複数のアイテムを設定します。

パラメータ

  • アイテム

    オブジェクト

    ストレージを更新する Key-Value ペアを指定するオブジェクト。ストレージ内の他の Key-Value ペアには影響しません。

    数値などのプリミティブ値は想定どおりにシリアル化されます。typeof "object" と "function" を持つ値は、通常 {} にシリアル化されます。ただし、Array（想定どおりにシリアル化）、Date、Regex（String 表現を使用してシリアル化）は例外です。

戻り値

  • Promise<void>

    Chrome 95 以降 Chrome 148 以降の browser.*

    成功時に解決されるか、失敗時に拒否される Promise。

setAccessLevel()

Chrome 102 以降 browser.*（Chrome 148 以降） 
browser.storage.StorageArea.setAccessLevel(
  accessOptions: object,
): Promise<void>

ストレージ領域に必要なアクセスレベルを設定します。デフォルトでは、session ストレージは信頼できるコンテキスト（拡張機能ページと Service Worker）に制限されますが、managed、local、sync ストレージは信頼できるコンテキストと信頼できないコンテキストの両方からアクセスできます。

パラメータ

  • accessOptions

    オブジェクト

    • accessLevel

      AccessLevel

      保管場所のアクセスレベル。

戻り値

  • Promise<void>

    成功時に解決されるか、失敗時に拒否される Promise。

イベント

onChanged

Chrome 73 以降 Chrome 148 以降は browser.* 
browser.storage.StorageArea.onChanged.addListener(
  callback: function,
)

1 つ以上のアイテムが変更されたときに呼び出されます。

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    (changes: object) => void

    • 変更

      オブジェクト