Interface ILockable

Readonlylocked

acquire

• acquire(signal?: null | AbortSignal): Promisable<Callable>

  Acquires the lock, waiting if necessary until it is available.

  Parameters

  • Optionalsignal: null | AbortSignal

    An optional AbortSignal to cancel the acquire operation.

  Returns Promisable<Callable>

  A promise that resolves to a function that releases the lock.

release

• release(): Promisable<void>

  Releases the lock.

  Returns Promisable<void>

withLock

• withLock<R>(
      func: MaybeAsyncCallableNoArgs<R>,
      signal?: null | AbortSignal,
  ): Promisable<R>

  Acquires the lock, executes the callback, and releases the lock.

  Type Parameters

  • R

  Parameters

  • func: MaybeAsyncCallableNoArgs<R>

    The callback to execute while holding the lock.

  • Optionalsignal: null | AbortSignal

    An optional AbortSignal to cancel the acquire operation.

  Returns Promisable<R>

  The result of the callback.