StorageArea

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

Methods

clear()

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

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

פרמטרים

  • callback

    פונקציה אופציונלית

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome 95 ואילך

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

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

get()

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

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

פרמטרים

  • מפתחות

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

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

  • callback

    פונקציה אופציונלית

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

    (items: object) => void

    • פריטים

      אובייקט

      אובייקט עם פריטים במיפויי מפתח-ערך.

החזרות

  • Promise<object>

    ‫Chrome 95 ואילך

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

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

getBytesInUse()

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

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

פרמטרים

  • מפתחות

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

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

  • callback

    פונקציה אופציונלית

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

    (bytesInUse: number) => void

    • bytesInUse

      number

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

החזרות

  • Promise<number>

    ‫Chrome 95 ואילך

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

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

getKeys()

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

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

פרמטרים

  • callback

    פונקציה אופציונלית

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

    (keys: string[]) => void

    • מפתחות

      string[]

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

החזרות

  • Promise<string[]>

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

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

remove()

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

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

פרמטרים

  • מפתחות

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

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

  • callback

    פונקציה אופציונלית

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome 95 ואילך

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

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

set()

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

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

פרמטרים

  • פריטים

    אובייקט

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

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

  • callback

    פונקציה אופציונלית

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome 95 ואילך

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

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

setAccessLevel()

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

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

פרמטרים

  • accessOptions

    אובייקט

    • accessLevel

      AccessLevel

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

  • callback

    פונקציה אופציונלית

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

    () => void

החזרות

  • Promise<void>

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

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

אירועים

onChanged

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

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

פרמטרים

  • callback

    פונקציה

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

    (changes: object) => void

    • שינויים

      אובייקט