Interface RwLockWriteGuard<T>

Readonly[toStringTag]

value

const guard = await rwlock.write();
console.log(guard.value); // Read the value
guard.value = newValue;   // Modify the value
guard.unlock();
Copy

downgrade

• downgrade(): RwLockReadGuard<T>

  Downgrades this write guard to a read guard atomically.

  The write lock is converted to a read lock without releasing it, allowing other waiting readers to proceed concurrently. Pending writers continue to wait until all readers (including this one) release their locks.

  After calling downgrade(), this guard is invalidated and must not be used — accessing value or calling unlock() will throw.

  Equivalent to Rust's RwLockWriteGuard::downgrade (stabilized in Rust 1.92.0).

  Returns RwLockReadGuard<T>

  A new RwLockReadGuard<T> providing shared read access.

  Since

  1.10.0

  See

  https://doc.rust-lang.org/std/sync/struct.RwLockWriteGuard.html#method.downgrade

  Example

  const guard = await rwlock.write();
  guard.value = newValue;
  // Downgrade to a read lock, releasing waiting readers
  const readGuard = guard.downgrade();
  try {
      console.log(readGuard.value); // other readers can proceed concurrently
  } finally {
      readGuard.unlock();
  }
  Copy

toString

• toString(): string

  Custom toString implementation.

  Returns string

  A string representation of the guard.

  Example

  const guard = await rwlock.write();
  console.log(guard.toString()); // 'RwLockWriteGuard(42)'
  Copy

unlock

• unlock(): void

  Releases the write lock.

  After calling unlock(), the guard should not be used.

  Returns void

  Example

  const guard = await rwlock.write();
  try {
      guard.value = newValue;
  } finally {
      guard.unlock();
  }
  Copy