Locks.mode

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

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

Syntax

var mode = Lock.mode

Value

One of "exclusive" or "shared".

Example

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

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

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

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

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

Specifications

Specification Status Comment
Web Locks API
The definition of 'mode' in that specification.
Draft Initial definition.

Browser compatibility

DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
mode
Experimental
Chrome Full support 69Edge Full support ≤79Firefox ? IE ? Opera Full support 56Safari ? WebView Android Full support 69Chrome Android Full support 69Firefox Android ? Opera Android Full support 48Safari iOS ? Samsung Internet Android Full support 10.0

Legend

Full support
Full support
Compatibility unknown
Compatibility unknown
Experimental. Expect behavior to change in the future.
Experimental. Expect behavior to change in the future.