StorageArea

StorageArea อินเทอร์เฟซใช้โดย chrome.storage API

เมธอด

clear()

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

นำรายการทั้งหมดออกจากพื้นที่เก็บข้อมูล

พารามิเตอร์

  • callback

    ฟังก์ชัน ไม่บังคับ

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    () => void

การคืนสินค้า

  • Promise<void>

    Chrome 95 ขึ้นไป

    ระบบรองรับ Promise สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ

get()

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

รับรายการอย่างน้อย 1 รายการจากพื้นที่เก็บข้อมูล

พารามิเตอร์

  • กุญแจ

    string | string[] | object ไม่บังคับ

    คีย์เดียวที่จะรับ รายการคีย์ที่จะรับ หรือพจนานุกรมที่ระบุค่าเริ่มต้น (ดูคำอธิบายของออบเจ็กต์) รายการหรือออบเจ็กต์ที่ว่างเปล่าจะแสดงผลออบเจ็กต์ผลลัพธ์ที่ว่างเปล่า ส่ง null เพื่อรับเนื้อหาทั้งหมดของพื้นที่เก็บข้อมูล

  • callback

    ฟังก์ชัน ไม่บังคับ

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    (items: object) => void

    • รายการ

      ออบเจ็กต์

      ออบเจ็กต์ที่มีรายการในการแมปคีย์-ค่า

การคืนสินค้า

  • Promise<object>

    Chrome 95 ขึ้นไป

    ระบบรองรับ Promise สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ

getBytesInUse()

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

รับปริมาณพื้นที่ (เป็นไบต์) ที่รายการอย่างน้อย 1 รายการใช้

พารามิเตอร์

  • กุญแจ

    string | string[] ไม่บังคับ

    คีย์เดียวหรือรายการคีย์เพื่อรับการใช้งานทั้งหมด รายการที่ว่างเปล่าจะแสดงผลเป็น 0 ส่ง null เพื่อดูการใช้งานทั้งหมดของพื้นที่เก็บข้อมูลทั้งหมด

  • callback

    ฟังก์ชัน ไม่บังคับ

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    (bytesInUse: number) => void

    • bytesInUse

      ตัวเลข

      ปริมาณพื้นที่ที่ใช้ในพื้นที่เก็บข้อมูลในหน่วยไบต์

การคืนสินค้า

  • Promise<number>

    Chrome 95 ขึ้นไป

    ระบบรองรับ Promise สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ

getKeys()

Promise Chrome 130 ขึ้นไป 
chrome.storage.StorageArea.getKeys(
  callback?: function,
): Promise<string[]>

รับคีย์ทั้งหมดจากที่เก็บข้อมูล

พารามิเตอร์

  • callback

    ฟังก์ชัน ไม่บังคับ

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    (keys: string[]) => void

    • กุญแจ

      string[]

      อาร์เรย์ที่มีคีย์ที่อ่านจากที่เก็บข้อมูล

การคืนสินค้า

  • Promise<string[]>

    ระบบรองรับ Promise สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ

remove()

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

นำรายการอย่างน้อย 1 รายการออกจากพื้นที่เก็บข้อมูล

พารามิเตอร์

  • กุญแจ

    สตริง | สตริง[]

    คีย์เดียวหรือรายการคีย์สำหรับรายการที่จะนำออก

  • callback

    ฟังก์ชัน ไม่บังคับ

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    () => void

การคืนสินค้า

  • Promise<void>

    Chrome 95 ขึ้นไป

    ระบบรองรับ Promise สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ

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 สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ

setAccessLevel()

Promise Chrome 102 ขึ้นไป 
chrome.storage.StorageArea.setAccessLevel(
  accessOptions: object,
  callback?: function,
): Promise<void>

กำหนดระดับการเข้าถึงที่ต้องการสำหรับพื้นที่เก็บข้อมูล โดยค่าเริ่มต้น session จะจำกัดเฉพาะบริบทที่เชื่อถือได้ (หน้าส่วนขยายและ Service Worker) ในขณะที่ managed, local และ sync จะอนุญาตการเข้าถึงจากทั้งบริบทที่เชื่อถือได้และไม่น่าเชื่อถือ

พารามิเตอร์

  • accessOptions

    ออบเจ็กต์

    • accessLevel

      AccessLevel

      ระดับการเข้าถึงของพื้นที่เก็บข้อมูล

  • callback

    ฟังก์ชัน ไม่บังคับ

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    () => void

การคืนสินค้า

  • Promise<void>

    ระบบรองรับ Promise สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ

กิจกรรม

onChanged

Chrome 73 ขึ้นไป 
chrome.storage.StorageArea.onChanged.addListener(
  callback: function,
)

ทริกเกอร์เมื่อมีการเปลี่ยนแปลงรายการอย่างน้อย 1 รายการ

พารามิเตอร์

  • callback

    ฟังก์ชัน

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    (changes: object) => void

    • การเปลี่ยนแปลง

      ออบเจ็กต์