StorageArea

Interfejs StorageArea jest używany przez interfejs chrome.storage API.

Metody

clear()

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

Usuwa wszystkie elementy z pamięci.

Parametry

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    () => void

Zwroty

  • Promise<void>

    Chrome 95 lub nowsza

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

get()

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

Pobiera co najmniej 1 element z pamięci.

Parametry

  • klucze

    string | string[] | object opcjonalny

    Pojedynczy klucz do pobrania, lista kluczy do pobrania lub słownik określający wartości domyślne (patrz opis obiektu). Pusta lista lub pusty obiekt zwrócą pusty obiekt wyniku. Przekaż null, aby uzyskać całą zawartość pamięci.

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    (items: object) => void

    • elementy

      obiekt

      Obiekt z elementami w mapowaniach par klucz-wartość.

Zwroty

  • Promise<object>

    Chrome 95 lub nowsza

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

getBytesInUse()

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

Pobiera ilość miejsca (w bajtach) zajmowanego przez co najmniej 1 element.

Parametry

  • klucze

    string | string[] opcjonalny

    Pojedynczy klucz lub lista kluczy, dla których chcesz uzyskać łączne wykorzystanie. Pusta lista zwróci wartość 0. Przekaż wartość null, aby uzyskać łączne wykorzystanie wszystkich miejsc na dane.

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    (bytesInUse: number) => void

    • bytesInUse

      liczba

      Ilość wykorzystywanego miejsca na dane (w bajtach).

Zwroty

  • Promise<number>

    Chrome 95 lub nowsza

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

getKeys()

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

Pobiera wszystkie klucze z pamięci.

Parametry

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    (keys: string[]) => void

    • klucze

      string[]

      Tablica z kluczami odczytanymi z pamięci.

Zwroty

  • Promise<string[]>

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

remove()

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

Usuwa co najmniej 1 element z pamięci.

Parametry

  • klucze

    string | string[]

    Pojedynczy klucz lub lista kluczy elementów do usunięcia.

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    () => void

Zwroty

  • Promise<void>

    Chrome 95 lub nowsza

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

set()

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

Ustawia wiele elementów.

Parametry

  • elementy

    obiekt

    Obiekt, który zawiera pary klucz-wartość do aktualizacji pamięci. Nie wpłynie to na inne pary klucz/wartość w pamięci.

    Wartości pierwotne, takie jak liczby, będą serializowane zgodnie z oczekiwaniami. Wartości ze znakami typeof, "object" i "function" są zwykle serializowane jako {}, z wyjątkiem znaków Array (serializowany zgodnie z oczekiwaniami), Date i Regex (serializowane przy użyciu reprezentacji String).

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    () => void

Zwroty

  • Promise<void>

    Chrome 95 lub nowsza

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

setAccessLevel()

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

Ustawia żądany poziom dostępu do obszaru pamięci. Domyślnie pamięć session jest ograniczona do zaufanych kontekstów (stron rozszerzeń i skryptów service worker), a pamięć managed, local i sync umożliwia dostęp zarówno z zaufanych, jak i niezaufanych kontekstów.

Parametry

  • accessOptions

    obiekt

    • accessLevel

      AccessLevel

      Poziom dostępu do obszaru pamięci.

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    () => void

Zwroty

  • Promise<void>

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

Wydarzenia

onChanged

Chrome 73 lub nowsza 
chrome.storage.StorageArea.onChanged.addListener(
  callback: function,
)

Wywoływane, gdy zmieni się co najmniej 1 element.

Parametry

  • callback

    funkcja

    Parametr callback wygląda tak:

    (changes: object) => void

    • poniższych zmian

      obiekt