StorageArea

ממשק StorageArea משמש את chrome.storage API.

Methods

clear()

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

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

החזרות

  • Promise<void>

    ‫Chrome 95 ואילך

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

get()

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

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

פרמטרים

  • מפתחות

    מחרוזת | מערך מחרוזות | אובייקט אופציונלי

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

החזרות

  • Promise<object>

    ‫Chrome 95 ואילך

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

getBytesInUse()

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

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

פרמטרים

  • מפתחות

    מחרוזת | מערך מחרוזות אופציונלי

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

החזרות

  • Promise<number>

    ‫Chrome 95 ואילך

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

getKeys()

‫Chrome 130 ואילך 
chrome.storage.StorageArea.getKeys(): Promise<string[]>

אחזור כל המפתחות מהאחסון.

החזרות

  • Promise<string[]>

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

remove()

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

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

פרמטרים

  • מפתחות

    מחרוזת | מערך מחרוזות

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

החזרות

  • Promise<void>

    ‫Chrome 95 ואילך

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

set()

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

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

פרמטרים

  • פריטים

    אובייקט

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

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

החזרות

  • Promise<void>

    ‫Chrome 95 ואילך

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

setAccessLevel()

‫Chrome 102 ואילך 
chrome.storage.StorageArea.setAccessLevel(
  accessOptions: object,
): Promise<void>

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

פרמטרים

  • accessOptions

    אובייקט

    • accessLevel

      AccessLevel

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

החזרות

  • Promise<void>

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

אירועים

onChanged

‫Chrome 73 ואילך 
chrome.storage.StorageArea.onChanged.addListener(
  callback: function,
)

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

פרמטרים

  • callback

    פונקציה

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

    (changes: object) => void

    • שינויים

      אובייקט