StorageArea

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

メソッド

clear()

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

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

戻り値

  • Promise<void>

    Chrome 95 以降

get()

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

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

パラメータ

  • string | string[] | object 省略可

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

戻り値

  • Promise<object>

    Chrome 95 以降

getBytesInUse()

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

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

パラメータ

  • string | string[] 省略可

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

戻り値

  • Promise<number>

    Chrome 95 以降

getKeys()

Chrome 130 以降
chrome.storage.StorageArea.getKeys(): Promise<string[]>

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

戻り値

  • Promise<string[]>

remove()

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

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

パラメータ

  • 文字列 | 文字列配列

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

戻り値

  • Promise<void>

    Chrome 95 以降

set()

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

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

パラメータ

  • アイテム

    オブジェクト

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

    数値などのプリミティブ値は、想定どおりにシリアル化されます。typeof "object""function" を含む値は、通常 {} にシリアル化されます。ただし、Array(想定どおりにシリアル化)、DateRegexString 表現を使用してシリアル化)は例外です。

戻り値

  • Promise<void>

    Chrome 95 以降

setAccessLevel()

Chrome 102 以降
chrome.storage.StorageArea.setAccessLevel(
  accessOptions: object,
)
: Promise<void>

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

パラメータ

  • accessOptions

    オブジェクト

    • accessLevel

      ストレージ領域のアクセスレベル。

戻り値

  • Promise<void>

イベント

onChanged

Chrome 73 以降
chrome.storage.StorageArea.onChanged.addListener(
  callback: function,
)

1 つ以上のアイテムが変更されたときに発生します。

パラメータ

  • callback

    関数

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

    (changes: object) => void

    • 変更

      オブジェクト