StorageArea

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

メソッド

clear()

Promise 
chrome.storage.StorageArea.clear(
  callback?: function,
): Promise<void>

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

パラメータ

  • callback

    関数 省略可

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

    () => void

戻り値

  • Promise<void>

    Chrome 95 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

get()

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

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

パラメータ

  • 鍵

    string | string[] | object 省略可

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

  • callback

    関数 省略可

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

    (items: object) => void

    • アイテム

      オブジェクト

      Key-Value マッピングのアイテムを含むオブジェクト。

戻り値

  • Promise<object>

    Chrome 95 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

getBytesInUse()

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

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

パラメータ

  • 鍵

    string | string[] 省略可

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

  • callback

    関数 省略可

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

    (bytesInUse: number) => void

    • bytesInUse

      数値

      ストレージで使用されている容量（バイト単位）。

戻り値

  • Promise<number>

    Chrome 95 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

getKeys()

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

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

パラメータ

  • callback

    関数 省略可

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

    (keys: string[]) => void

    • 鍵

      string[]

      ストレージから読み取られたキーを含む配列。

戻り値

  • Promise<string[]>

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

remove()

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

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

パラメータ

  • 鍵

    文字列 | 文字列配列

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

  • callback

    関数 省略可

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

    () => void

戻り値

  • Promise<void>

    Chrome 95 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

set()

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

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

パラメータ

  • アイテム

    オブジェクト

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

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

  • callback

    関数 省略可

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

    () => void

戻り値

  • Promise<void>

    Chrome 95 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

setAccessLevel()

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

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

パラメータ

  • accessOptions

    オブジェクト

    • accessLevel

      AccessLevel

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

  • callback

    関数 省略可

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

    () => void

戻り値

  • Promise<void>

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

イベント

onChanged

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

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

パラメータ

  • callback

    関数

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

    (changes: object) => void

    • 変更

      オブジェクト