Skip to main content

weblocks

Coordinate work across tabs and workers with a named, async lock via the Web Locks API.

Import: @rtorcato/browser-common/weblocks

📖 MDN: Web Locks API · 📊 caniuse: weblocks

Web Locks API needs a secure context. withLock throws where unsupported — guard with isWebLocksAvailable() first.

Example​

import { isWebLocksAvailable, withLock } from '@rtorcato/browser-common/weblocks'

if (isWebLocksAvailable()) {
  const result = await withLock('sync', async () => fetchAndStore())
}

Exports​

  • isWebLocksAvailable() — feature check
  • withLock(name, callback) — runs callback while holding the named lock; returns the callback's result

See the API reference for full signatures.