Firefox Tomorrow

web api instance property

Lock: mode property

View on MDN ↗

Secure context Available in workers

The mode read-only property of the Lock interface returns the access mode passed to request() when the lock was requested. The mode is either "exclusive" (the default) or "shared".

Value

One of "exclusive" or "shared".

Examples

The following examples show how the mode property is passed in the call to request(). LockManager is the object returned by locks.

// Should show "exclusive" (the default)
navigator.locks.request("my_resource", showLockProperties);

// Should show "exclusive"
navigator.locks.request(
  "my_resource",
  { mode: "exclusive" },
  showLockProperties,
);

// Should show "shared"
navigator.locks.request("my_resource", { mode: "shared" }, showLockProperties);

function showLockProperties(lock) {
  console.log(`The lock name is: ${lock.name}`);
  console.log(`The lock mode is: ${lock.mode}`);
}

Specifications

SpecificationsStandards references are available on the canonical MDN page.

Browser compatibility

Browser compatibilityCompatibility data is available on the canonical MDN page.