SharedStorage: set() method

Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

Phương thức set() của giao diện SharedStorage lưu trữ một cặp key-value mới trong bộ lưu trữ chia sẻ của nguồn gốc hiện tại hoặc cập nhật cặp hiện có.

Cú pháp

js
set(key, value)
set(key, value, options)

Tham số

key

Một chuỗi đại diện cho key trong cặp key-value mà bạn muốn thêm hoặc cập nhật.

value

Một chuỗi đại diện cho giá trị bạn muốn thêm hoặc cập nhật.

options Optional

Một đối tượng tùy chọn chứa các thuộc tính sau:

ignoreIfPresent

Một giá trị boolean. Giá trị true khiến thao tác set hủy bỏ nếu cặp key-value với key được chỉ định đã tồn tại. Giá trị mặc định false khiến thao tác set ghi đè lên giá trị trước đó.

Giá trị trả về

Một Promise thực hiện với undefined.

Ngoại lệ

  • Promise từ chối với TypeError nếu:
    • Mục nhập được tạo không được lưu trữ thành công trong cơ sở dữ liệu do bộ lưu trữ chia sẻ không khả dụng (ví dụ: bị tắt bởi cài đặt trình duyệt).
    • key và/hoặc value vượt quá độ dài tối đa do trình duyệt xác định.
    • Trang gọi không có Shared Storage API được bao gồm trong quy trình đăng ký privacy sandbox thành công.
  • Trong trường hợp WorkletSharedStorage, Promise từ chối với TypeError nếu module worklet chưa được thêm bằng SharedStorageWorklet.addModule().

Note: Trong trường hợp WindowSharedStorage, nếu thao tác set() không ghi thành công vào cơ sở dữ liệu vì lý do khác ngoài bộ lưu trữ chia sẻ không khả dụng, không có lỗi nào được ném ra, thao tác vẫn thực hiện với undefined.

Ví dụ

js
window.sharedStorage
  .set("ab-testing-group", "0", {
    ignoreIfPresent: true,
  })
  .then(() => console.log("Set operation completed"));

Thông số kỹ thuật

Specification
Shared Storage API
# dom-sharedstorage-set

Tương thích trình duyệt

Xem thêm