Storage Area

رابط StorageArea توسط API chrome.storage استفاده می‌شود.

روش‌ها

clear()

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

همه موارد را از انبار خارج می‌کند.

پارامترها

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    () => void

بازگشت‌ها

  • قول<void>

    کروم ۹۵+

    Promiseها فقط برای Manifest V3 و نسخه‌های بعدی پشتیبانی می‌شوند، سایر پلتفرم‌ها باید از callbackها استفاده کنند.

get()

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

یک یا چند مورد را از انبار دریافت می‌کند.

پارامترها

  • کلیدها

    رشته | رشته[] | شیء اختیاری

    یک کلید واحد برای دریافت، لیستی از کلیدها برای دریافت، یا یک دیکشنری که مقادیر پیش‌فرض را مشخص می‌کند (به توضیحات شیء مراجعه کنید). یک لیست یا شیء خالی، یک شیء نتیجه خالی را برمی‌گرداند. برای دریافت کل محتوای ذخیره‌سازی، مقدار null را وارد کنید.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    (items: object) => void

    • اقلام

      شیء

      شیء با آیتم‌هایی در نگاشت‌های کلید-مقدارشان.

بازگشت‌ها

  • قول دادن<object>

    کروم ۹۵+

    Promiseها فقط برای Manifest V3 و نسخه‌های بعدی پشتیبانی می‌شوند، سایر پلتفرم‌ها باید از callbackها استفاده کنند.

getBytesInUse()

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

مقدار فضایی (بر حسب بایت) که توسط یک یا چند آیتم استفاده می‌شود را برمی‌گرداند.

پارامترها

  • کلیدها

    رشته | رشته[] اختیاری

    یک کلید یا لیستی از کلیدها برای دریافت کل استفاده. یک لیست خالی 0 را برمی‌گرداند. برای دریافت کل استفاده از کل فضای ذخیره‌سازی، null را وارد کنید.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    (bytesInUse: number) => void

    • بایت‌های در حال استفاده

      شماره

      مقدار فضای استفاده شده در حافظه، بر حسب بایت.

بازگشت‌ها

  • قول<number>

    کروم ۹۵+

    Promiseها فقط برای Manifest V3 و نسخه‌های بعدی پشتیبانی می‌شوند، سایر پلتفرم‌ها باید از callbackها استفاده کنند.

getKeys()

قول کروم ۱۳۰+
chrome.storage.StorageArea.getKeys(
  callback?: function,
): Promise<string[]>

تمام کلیدها را از حافظه می‌گیرد.

پارامترها

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    (keys: string[]) => void

    • کلیدها

      رشته[]

      آرایه‌ای با کلیدهای خوانده شده از حافظه.

بازگشت‌ها

  • قول <string[]>

    Promiseها فقط برای Manifest V3 و نسخه‌های بعدی پشتیبانی می‌شوند، سایر پلتفرم‌ها باید از callbackها استفاده کنند.

remove()

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

یک یا چند مورد را از انبار حذف می‌کند.

پارامترها

  • کلیدها

    رشته | رشته[]

    یک کلید یا فهرستی از کلیدها برای حذف موارد.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    () => void

بازگشت‌ها

  • قول<void>

    کروم ۹۵+

    Promiseها فقط برای Manifest V3 و نسخه‌های بعدی پشتیبانی می‌شوند، سایر پلتفرم‌ها باید از callbackها استفاده کنند.

set()

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

چندین مورد را تنظیم می‌کند.

پارامترها

  • اقلام

    شیء

    شیء‌ای که هر جفت کلید/مقدار را برای به‌روزرسانی فضای ذخیره‌سازی ارائه می‌دهد. سایر جفت‌های کلید/مقدار موجود در فضای ذخیره‌سازی تحت تأثیر قرار نخواهند گرفت.

    مقادیر اولیه مانند اعداد طبق انتظار سریالی می‌شوند. مقادیری که typeof "object" و "function" دارند معمولاً به {} سریالی می‌شوند، به استثنای Array (طبق انتظار سریالی می‌شود)، Date و Regex (با استفاده از نمایش String خود سریالی می‌شوند).

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    () => void

بازگشت‌ها

  • قول<void>

    کروم ۹۵+

    Promiseها فقط برای Manifest V3 و نسخه‌های بعدی پشتیبانی می‌شوند، سایر پلتفرم‌ها باید از callbackها استفاده کنند.

setAccessLevel()

قول کروم ۱۰۲+
chrome.storage.StorageArea.setAccessLevel(
  accessOptions: object,
  callback?: function,
): Promise<void>

سطح دسترسی مورد نظر را برای ناحیه ذخیره‌سازی تنظیم می‌کند. به طور پیش‌فرض، ذخیره‌سازی session به زمینه‌های قابل اعتماد (صفحات افزونه و سرویس ورکرها) محدود می‌شود، در حالی که ذخیره‌سازی managed ، local و sync امکان دسترسی از هر دو زمینه قابل اعتماد و غیر قابل اعتماد را فراهم می‌کند.

پارامترها

  • گزینه‌های دسترسی

    شیء

    • سطح دسترسی

      سطح دسترسی

      سطح دسترسی به فضای ذخیره‌سازی

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    () => void

بازگشت‌ها

  • قول<void>

    Promiseها فقط برای Manifest V3 و نسخه‌های بعدی پشتیبانی می‌شوند، سایر پلتفرم‌ها باید از callbackها استفاده کنند.

رویدادها

onChanged

کروم ۷۳+
chrome.storage.StorageArea.onChanged.addListener(
  callback: function,
)

وقتی یک یا چند مورد تغییر کنند، اجرا می‌شود.

پارامترها

  • تماس برگشتی

    تابع

    پارامتر callback به شکل زیر است: 

    (changes: object) => void

    • تغییرات

      شیء