Web/API/Lock/mode

This is an experimental technologyCheck 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 APIThe definition of 'mode' in that specification.	Draft	Initial definition.

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`mode` Experimental'	Chrome Full support 69	Edge Full support ≤79	Firefox ?	IE No support No	Opera Full support 56	Safari ?	WebView Android Full support 69	Chrome Android Full support 69	Firefox Android ?	Opera Android Full support 48	Safari iOS ?	Samsung Internet Android Full support 10.0

Legend

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

Locks.mode by Mozilla Contributors is licensed under CC-BY-SA 2.5.