StorageArea

refresh date: 2026-09-25 robots: noindex

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

روش‌ها

clear()

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

همه موارد را از فضای ذخیره‌سازی برمی‌دارد.

پارامترها

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    () => void

بازگشتی‌ها

  • Promise<void>

    Chrome نسخه ۹۵ و بالاتر

    Promise که درصورت موفقیت حل می‌شود یا درصورت شکست رد می‌شود.

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

get()

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

یک یا چند مورد را از فضای ذخیره‌سازی دریافت می‌کند.

پارامترها

  • کلید

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

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (items: object) => void

    • موارد

      شیء

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

بازگشتی‌ها

  • Promise<object>

    Chrome نسخه ۹۵ و بالاتر

    Promise که با شیء حاوی نقشه مقدار کلید برای موارد درخواستی حل می‌شود، یا درصورت ناموفق بودن رد می‌شود.

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

getBytesInUse()

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

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

پارامترها

  • کلید

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

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (bytesInUse: number) => void

    • bytesInUse

      شماره

      مقدار فضای استفاده‌شده در فضای ذخیره‌سازی، به بایت.

بازگشتی‌ها

  • Promise<number>

    Chrome نسخه ۹۵ و بالاتر

    Promise که با مقدار فضای استفاده‌شده توسط فضای ذخیره‌سازی حل می‌شود یا درصورت ناموفق بودن رد می‌شود.

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

getKeys()

Promise Chrome نسخه ۱۳۰ و بالاتر 
chrome.storage.StorageArea.getKeys(
  callback?: function,
): Promise<string[]>

همه کلیدها را از فضای ذخیره‌سازی دریافت می‌کند.

پارامترها

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (keys: string[]) => void

    • کلید

      string[]

      آرایه با کلیدهای خوانده‌شده از فضای ذخیره‌سازی.

بازگشتی‌ها

  • Promise<string[]>

    Promise که با کلیدهای فضای ذخیره‌سازی حل می‌شود یا درصورت ناموفق بودن رد می‌شود.

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

remove()

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

یک یا چند مورد را از فضای ذخیره‌سازی برمی‌دارد.

پارامترها

  • کلید

    رشته | رشته[]

    یک کلید یا فهرستی از کلیدها برای مواردی که باید برداشته شوند.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    () => void

بازگشتی‌ها

  • Promise<void>

    Chrome نسخه ۹۵ و بالاتر

    Promise که درصورت موفقیت حل می‌شود یا درصورت شکست رد می‌شود.

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

set()

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

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

پارامترها

  • موارد

    شیء

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

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    () => void

بازگشتی‌ها

  • Promise<void>

    Chrome نسخه ۹۵ و بالاتر

    Promise که درصورت موفقیت حل می‌شود یا درصورت شکست رد می‌شود.

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

setAccessLevel()

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

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

پارامترها

  • accessOptions

    شیء

    • accessLevel

      AccessLevel

      سطح دسترسی به محوطه انبار.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    () => void

بازگشتی‌ها

  • Promise<void>

    Promise که درصورت موفقیت حل می‌شود یا درصورت شکست رد می‌شود.

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

رویدادها

onChanged

Chrome نسخه ۷۳ به بالا 
chrome.storage.StorageArea.onChanged.addListener(
  callback: function,
)

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

پارامترها

  • تماس برگشتی

    عملکرد

    پارامتر callback به‌صورت زیر است: 

    (changes: object) => void

    • تغییرات

      شیء