ioredis-lock/lib/redislock.js

Node distributed locking using redis with ioredis adapter

"use strict";

/**
 * redislock exposes a total of three functions: createLock, setDefaults,
 * and getActiveLocks.
 */
const Lock = require('./lock');

const errors = require('./errors');
/**
 * Returns a new Lock instance, configured for use with the supplied redis
 * client, as well as options, if provided.
 *
 * @param {RedisClient} client    The ioredis client to use
 * @param {object} [options] Options to apply
 *
 * @return {Lock} A new lock object
 */


exports.createLock = function createLock(client, options) {
  return new Lock(client, options);
};
/**
 * Sets the default options to be used by any new lock created by redislock.
 * Only available options are modified, and all other keys are ignored.
 *
 * @param {object} options The options to set
 */


exports.setDefaults = function setDefaults(_options) {
  const options = _options || {};
  const keys = Object.keys(Lock._defaults);
  keys.forEach(key => {
    if (options[key] !== null && options[key] !== undefined) {
      Lock._defaults[key] = parseInt(options[key], 10);
    }
  });
};
/**
 * Returns an array of currently active/acquired locks.
 *
 * @return {Lock[]} An array of Lock objects
 */


exports.getAcquiredLocks = function getAcquiredLocks() {
  return Array.from(Lock._acquiredLocks);
};
/**
 * The constructor function for a LockAcquisitionError.
 */


exports.LockAcquisitionError = errors.LockAcquisitionError;
/**
 * The constructor function for a LockReleaseError.
 */

exports.LockReleaseError = errors.LockReleaseError;
/**
 * The constructor function for a LockExtendError
 */

exports.LockExtendError = errors.LockExtendError;