LockManager: phương thức request()

Cú pháp

request(name, callback)
request(name, options, callback)

Tham số

name

Định danh cho khóa bạn muốn yêu cầu.

options Optional

Đối tượng mô tả đặc điểm của khóa bạn muốn tạo. Các giá trị hợp lệ là:

mode Optional

Hoặc là "exclusive" hoặc "shared". Giá trị mặc định là "exclusive".

ifAvailable Optional

Nếu true, yêu cầu khóa sẽ chỉ được cấp nếu nó chưa được giữ. Nếu không thể cấp, callback sẽ được gọi với null thay vì phiên bản Lock. Giá trị mặc định là false.

steal Optional

Nếu true, thì bất kỳ khóa đang giữ nào có cùng tên sẽ được giải phóng, và yêu cầu sẽ được cấp, ưu tiên hơn bất kỳ yêu cầu nào trong hàng đợi cho nó. Giá trị mặc định là false.

Warning: Sử dụng cẩn thận! Mã đang chạy trước đó bên trong khóa tiếp tục chạy và có thể xung đột với mã hiện đang giữ khóa.

signal Optional

Một AbortSignal (thuộc tính signal của AbortController); nếu được chỉ định và AbortController bị hủy bỏ, yêu cầu khóa sẽ bị bỏ nếu chưa được cấp.

callback

Phương thức được gọi khi khóa được cấp. Khóa tự động được giải phóng khi callback trả về (hoặc khi ngoại lệ được ném). Thông thường callback là hàm async, khiến khóa chỉ được giải phóng khi hàm async hoàn toàn kết thúc.

Giá trị trả về

Một Promise được giải quyết (hoặc từ chối) với kết quả của callback sau khi khóa được giải phóng, hoặc từ chối nếu yêu cầu bị hủy bỏ.

Ngoại lệ

Phương thức này có thể trả về một promise bị từ chối với DOMException của một trong các loại sau:

InvalidStateError DOMException

Được ném nếu tài liệu của môi trường không hoàn toàn hoạt động.

SecurityError DOMException

Được ném nếu không thể lấy trình quản lý khóa cho môi trường hiện tại.

NotSupportedError DOMException

Được ném nếu name bắt đầu bằng dấu gạch ngang (-), cả hai tùy chọn steal và ifAvailable đều là true, hoặc nếu tùy chọn signal tồn tại và hoặc tùy chọn steal hoặc ifAvailable là true.

AbortError DOMException

Được ném nếu tùy chọn signal tồn tại và bị hủy bỏ.

Ví dụ

Ví dụ chung

Ví dụ sau đây cho thấy cách sử dụng cơ bản của phương thức request() với một hàm không đồng bộ làm callback. Sau khi callback được gọi, không có mã nào khác đang chạy trên origin này có thể giữ my_resource cho đến khi callback trả về.

await navigator.locks.request("my_resource", async (lock) => {
  // The lock was granted.
});

Ví dụ mode

Ví dụ sau đây cho thấy cách sử dụng tùy chọn mode cho người đọc và người viết.

async function doRead() {
  await navigator.locks.request(
    "my_resource",
    { mode: "shared" },
    async (lock) => {
      // Read code here.
    },
  );
}

async function doWrite() {
  await navigator.locks.request(
    "my_resource",
    { mode: "exclusive" },
    async (lock) => {
      // Write code here.
    },
  );
}

Ví dụ ifAvailable

Để lấy khóa chỉ khi nó chưa được giữ, sử dụng tùy chọn ifAvailable.

await navigator.locks.request(
  "my_resource",
  { ifAvailable: true },
  async (lock) => {
    if (!lock) {
      // The lock was not granted - get out fast.
      return;
    }

    // The lock was granted, and no other running code in this origin is holding
    // the 'my_res_lock' lock until this returns.
  },
);

Ví dụ signal

Để chỉ chờ khóa trong một khoảng thời gian ngắn, sử dụng tùy chọn signal.

const controller = new AbortController();
// Wait at most 200ms.
setTimeout(() => controller.abort(), 200);

try {
  await navigator.locks.request(
    "my_resource",
    { signal: controller.signal },
    async (lock) => {
      // The lock was acquired!
    },
  );
} catch (ex) {
  if (ex.name === "AbortError") {
    // The request aborted before it could be granted.
  }
}

Thông số kỹ thuật

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