StorageArea

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

Methods

clear()

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

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

החזרות

  • Promise<void>

    ‫Chrome 95 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

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

get()

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

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

פרמטרים

  • מפתחות

    string | string[] | object optional

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

החזרות

  • Promise<object>

    ‫Chrome 95 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

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

getBytesInUse()

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

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

פרמטרים

  • מפתחות

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

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

החזרות

  • Promise<number>

    ‫Chrome 95 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

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

getKeys()

‫Chrome מגרסה 130 ואילך ‫browser.* ‎ מגרסה 148 של Chrome 
browser.storage.StorageArea.getKeys(): Promise<string[]>

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

החזרות

  • Promise<string[]>

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

remove()

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

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

פרמטרים

  • מפתחות

    string | string[]‎

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

החזרות

  • Promise<void>

    ‫Chrome 95 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

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

set()

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

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

פרמטרים

  • פריטים

    אובייקט

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

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

החזרות

  • Promise<void>

    ‫Chrome 95 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

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

setAccessLevel()

‫Chrome 102 ואילך ‫‎browser.* ‎ מגרסת Chrome 148 
browser.storage.StorageArea.setAccessLevel(
  accessOptions: object,
): Promise<void>

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

פרמטרים

  • accessOptions

    אובייקט

    • accessLevel

      AccessLevel

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

החזרות

  • Promise<void>

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

אירועים

onChanged

Chrome 73 ואילך browser.* ‎ מ-Chrome 148 
browser.storage.StorageArea.onChanged.addListener(
  callback: function,
)

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

פרמטרים

  • callback

    פונקציה

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

    (changes: object) => void

    • שינויים

      אובייקט