dom/org.scalajs.dom/LockOptions

LockOptions

@JSType
trait LockOptions extends Object

An object describing characteristics of the lock you want to create.

class Object
trait Any
class Object
trait Matchable
class Any

Value members

Inherited methods

def hasOwnProperty(v: String): Boolean
Inherited from:
Object
def isPrototypeOf(v: Object): Boolean
Inherited from:
Object
def propertyIsEnumerable(v: String): Boolean
Inherited from:
Object
def toLocaleString(): String
Inherited from:
Object
def valueOf(): Any
Inherited from:
Object

Concrete fields

@ExposedJSMember @JSOptional
var ifAvailable: UndefOr[Boolean]

If true, the lock request will only be granted if it is not already held. If it cannot be granted, the callback will be invoked with null instead of a Lock instance. The default value is false.

If true, the lock request will only be granted if it is not already held. If it cannot be granted, the callback will be invoked with null instead of a Lock instance. The default value is false.

@ExposedJSMember @JSOptional
var mode: UndefOr[LockMode]

Either "exclusive" or "shared". The default value is "exclusive".

Either "exclusive" or "shared". The default value is "exclusive".

@ExposedJSMember @JSOptional
var signal: UndefOr[AbortSignal]

An AbortSignal (the signal property of an AbortController); if specified and the AbortController is aborted, the lock request is dropped if it was not already granted.

An AbortSignal (the signal property of an AbortController); if specified and the AbortController is aborted, the lock request is dropped if it was not already granted.

@ExposedJSMember @JSOptional
var steal: UndefOr[Boolean]

If true, then any held locks with the same name will be released, and the request will be granted, preempting any queued requests for it. The default value is false.

If true, then any held locks with the same name will be released, and the request will be granted, preempting any queued requests for it. The default value is false.