kotlin-browser/web.locks

Package-level declarations

Types

Lock

class Lock

The Lock interface of the Web Locks API provides the name and mode of a lock. Available only in secure contexts.

LockGrantedCallback

typealias LockGrantedCallback<T> = (lock: Lock?) -> T

LockInfo

interface LockInfo

LockManager

class LockManager

The LockManager interface of the Web Locks API provides methods for requesting a new Lock object and querying for an existing Lock object. Available only in secure contexts.

LockManagerSnapshot

interface LockManagerSnapshot

LockMode

sealed interface LockMode

LockOptions

interface LockOptions : Abortable

Properties

exclusive

val LockMode.Companion.exclusive: LockMode

shared

val LockMode.Companion.shared: LockMode

Functions

query

inline suspend fun LockManager.query(): LockManagerSnapshot

The query() method of the LockManager interface returns a Promise that resolves with an object containing information about held and pending locks.

request

inline suspend fun <T : JsAny?> LockManager.request(name: String, noinline callback: LockGrantedCallback<T>): T

The request() method of the LockManager interface requests a Lock object with parameters specifying its name and characteristics.

inline suspend fun <T : JsAny?> LockManager.request(name: String, options: LockOptions, noinline callback: LockGrantedCallback<T>): T