Class WebLock

A Lock implement using Web Lock API.

Implements

Lock

Index

Constructors

Properties

count handle? locks name resolve? shared

Methods

acquire getHandle release requestLock tryAcquire

Constructors

constructor

new WebLock(__namedParameters?): WebLock
Parameters
- __namedParameters: WebLockOptions = {}
Returns WebLock
- Defined in packages/commons/src/async/web-lock.ts:18

Properties

`Protected` count

count: number = 0

`Private` `Optional` handle

handle?: Promise<void>

`Protected` `Readonly` locks

locks: LockManager

`Readonly` name

name: string

Unique name of the lock.

`Protected` `Optional` resolve

resolve?: (() => void)

Type declaration

- (): void
- Returns void

`Readonly` shared

shared: boolean

Whether the lock is shared.

Methods

acquire

acquire(options?): Promise<void>
Waits for a lock to be acquired.
Parameters
- Optional options: AbortOptions
Returns Promise<void>
Implementation of Lock.acquire
- Defined in packages/commons/src/async/web-lock.ts:28

`Protected` getHandle

getHandle(): Promise<void>
Returns Promise<void>
- Defined in packages/commons/src/async/web-lock.ts:87

release

release(): void
Releases a lock.

Returns void
Implementation of Lock.release
- Defined in packages/commons/src/async/web-lock.ts:56

`Protected` requestLock

requestLock(options): Promise<boolean>
Parameters
- options: AbortOptions & {
  ifAvailable: boolean;
  }
Returns Promise<boolean>
- Defined in packages/commons/src/async/web-lock.ts:64

tryAcquire

tryAcquire(): MaybePromise<boolean>
Tried to acquire a lock. Returns true if success, false otherwise.

Returns MaybePromise<boolean>
Implementation of Lock.tryAcquire
- Defined in packages/commons/src/async/web-lock.ts:42

Generated using TypeDoc