StorageArea

refresh date: 2026-09-25 robots: noindex

הממשק StorageArea משמש את ה-API של chrome.storage.

Methods

clear()

Promise

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

הסרת כל הפריטים מהאחסון.

פרמטרים

• callback

  function optional

  הפרמטר callback נראה כך:

  () => void

החזרות

• Promise<void>

  ‫Chrome מגרסה 95 ואילך

  אובייקט Promise שמותאם כשהפעולה מצליחה, או נדחה אם היא נכשלת.

  הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

get()

Promise

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

מקבל פריט אחד או יותר מהאחסון.

פרמטרים

• מפתחות

  string | string[] | object optional

  מפתח יחיד לאחזור, רשימת מפתחות לאחזור או מילון שמציין ערכי ברירת מחדל (ראו תיאור של האובייקט). רשימה או אובייקט ריקים יחזירו אובייקט תוצאה ריק. מעבירים את null כדי לקבל את כל התוכן של האחסון.

• callback

  function optional

  הפרמטר callback נראה כך:

  (items: object) => void

  • פריטים

    אובייקט

    אובייקט עם פריטים במיפויים של ערכי המפתח שלהם.

החזרות

• Promise<object>

  ‫Chrome מגרסה 95 ואילך

  Promise שמתקבל עם אובייקט שמכיל מפה של מפתח/ערך לפריטים המבוקשים, או נדחה במקרה של כשל.

  הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

getBytesInUse()

Promise

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

מציג את נפח האחסון (בבייטים) שפריט אחד או יותר תופסים.

פרמטרים

• מפתחות

  string | string[] אופציונלי

  מפתח יחיד או רשימת מפתחות כדי לקבל את השימוש הכולל. רשימה ריקה תחזיר 0. כדי לקבל את נפח האחסון הכולל בשימוש, מעבירים את הערך null.

• callback

  function optional

  הפרמטר callback נראה כך:

  (bytesInUse: number) => void

  • bytesInUse

    number

    נפח האחסון שבשימוש, בבייטים.

החזרות

• Promise<number>

  ‫Chrome מגרסה 95 ואילך

  אובייקט Promise שמותאם לנפח האחסון שבשימוש, או נדחה אם הפעולה נכשלת.

  הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

getKeys()

Promise Chrome 130+

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

מקבל את כל המפתחות מהאחסון.

פרמטרים

• callback

  function optional

  הפרמטר callback נראה כך:

  (keys: string[]) => void

  • מפתחות

    string[]‎

    מערך עם מפתחות שנקראו מהאחסון.

החזרות

• Promise<string[]>

  אובייקט Promise שמותאם למפתחות האחסון, או נדחה אם הפעולה נכשלת.

  הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

remove()

Promise

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

הסרה של פריט אחד או יותר מהאחסון.

פרמטרים

• מפתחות

  string | string[]‎

  מפתח יחיד או רשימה של מפתחות לפריטים שרוצים להסיר.

• callback

  function optional

  הפרמטר callback נראה כך:

  () => void

החזרות

• Promise<void>

  ‫Chrome מגרסה 95 ואילך

  אובייקט Promise שמותאם כשהפעולה מצליחה, או נדחה אם היא נכשלת.

  הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

set()

Promise

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

הגדרת כמה פריטים.

פרמטרים

• פריטים

  אובייקט

  אובייקט שמספק כל צמד מפתח/ערך לעדכון האחסון. צמדי מפתח/ערך אחרים באחסון לא יושפעו.

  ערכים פרימיטיביים כמו מספרים יעברו סריאליזציה כצפוי. ערכים עם typeof "object" ו-"function" בדרך כלל יעברו סריאליזציה ל-{}, מלבד Array (עובר סריאליזציה כצפוי), Date ו-Regex (עוברים סריאליזציה באמצעות הייצוג שלהם ב-String).

• callback

  function optional

  הפרמטר callback נראה כך:

  () => void

החזרות

• Promise<void>

  ‫Chrome מגרסה 95 ואילך

  אובייקט Promise שמותאם כשהפעולה מצליחה, או נדחה אם היא נכשלת.

  הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

setAccessLevel()

Promise Chrome 102 ואילך

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

מגדירה את רמת הגישה הרצויה לאזור האחסון. כברירת מחדל, האחסון של session מוגבל להקשרים מהימנים (דפי תוספים ו-Service Workers), ואילו האחסון של managed,‏ local ו-sync מאפשר גישה גם מהקשרים מהימנים וגם מהקשרים לא מהימנים.

פרמטרים

• accessOptions

  אובייקט

  • accessLevel

    AccessLevel

    רמת הגישה של אזור האחסון.

• callback

  function optional

  הפרמטר callback נראה כך:

  () => void

החזרות

• Promise<void>

  אובייקט Promise שמותאם כשהפעולה מצליחה, או נדחה אם היא נכשלת.

  הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

אירועים

onChanged

‫Chrome מגרסה 73 ואילך

chrome.storage.StorageArea.onChanged.addListener(
  callback: function,
)

מופעל כשפריט אחד או יותר משתנה.

פרמטרים

• callback

  פונקציה

  הפרמטר callback נראה כך:

  (changes: object) => void

  • שינויים

    אובייקט