Class asynclock

constructor

• new asynclock(options?): asynclock

• Parameters

  • Optional options: AsyncLockOptions

  Returns asynclock

Static Readonly DEFAULT_MAX_OCCUPATION_TIME

Static Readonly DEFAULT_MAX_PENDING

Static Readonly DEFAULT_TIMEOUT

acquire

• acquire<T>(key, fn, opts?): Promise<T>

• Lock on asynchronous code.

  Type Parameters

  • T

  Parameters

  • key: string | string[]

    resource key or keys to lock

  • fn: (() => T | PromiseLike<T>) | ((done) => any)

    function to execute

  • Optional opts: AsyncLockOptions

    options

  Returns Promise<T>

  Example

  import AsyncLock = require('async-lock');
  const lock = new AsyncLock();
  
  lock.acquire(
      key,
      () => {
          // return value or promise
      },
      opts
  ).then(() => {
      // lock released
  });
  Copy

• acquire<T>(key, fn, cb, opts?): void

• Lock on asynchronous code.

  Type Parameters

  • T

  Parameters

  • key: string | string[]

    resource key or keys to lock

  • fn: ((done) => any)

    function to execute

    • • (done): any

      • Parameters

        • done: AsyncLockDoneCallback<T>

        Returns any

  • cb: AsyncLockDoneCallback<T>

    callback function

  • Optional opts: AsyncLockOptions

    options

  Returns void

  Example

  import AsyncLock = require('async-lock');
  const lock = new AsyncLock();
  
  lock.acquire(
      key,
      (done) => {
          // async work
          done(err, ret);
      },
      (err, ret) => {
          // lock released
      },
      opts
  );
  Copy

isBusy

• isBusy(key?): boolean

• Whether there is any running or pending async function.

  Parameters

  • Optional key: string

  Returns boolean